Skip to content

docs: clarify tenant param is only for Databend Cloud management mode#781

Merged
youngsofun merged 2 commits into
databendlabs:mainfrom
youngsofun:doc/clarify-tenant-management-mode
Jun 23, 2026
Merged

docs: clarify tenant param is only for Databend Cloud management mode#781
youngsofun merged 2 commits into
databendlabs:mainfrom
youngsofun:doc/clarify-tenant-management-mode

Conversation

@youngsofun

Copy link
Copy Markdown
Member

Summary

Clarify that the tenant DSN parameter is only used in Databend Cloud management mode, not for specifying tenant in normal usage.

Motivation

The tenant parameter 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:

  • Removes tenant from the user-facing DSN documentation in README.md (users shouldn't need it)
  • Adds code comments in core/src/client.rs and driver/src/flight_sql.rs to make the intent clear for developers

Testing

Documentation and comment-only change. Verified with cargo check — no build errors.

@youngsofun youngsofun changed the title doc: clarify tenant param is only for Databend Cloud management mode docs: clarify tenant param is only for Databend Cloud management mode Jun 23, 2026
@youngsofun youngsofun merged commit b206a8d into databendlabs:main Jun 23, 2026
42 of 43 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant