Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youngsofun merged 2 commits into from
Jun 23, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e1cb5a
doc: clarify tenant param is only for Databend Cloud management mode
youngsofun Jun 23, 2026
677be64
Merge branch 'main' into doc/clarify-tenant-management-mode
youngsofun Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,6 @@ Examples:

| Arg | Description |
| ----------------- | ------------------------------------ |
| `tenant` | Tenant ID, Databend Cloud only. |
| `warehouse` | Warehouse name, Databend Cloud only. |
| `sslmode` | Set to `disable` if not using tls. |
| `tls_ca_file` | Custom root CA certificate path. |
Expand Down
4 changes: 4 additions & 0 deletions core/src/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ pub struct APIClient {

auth: Arc<dyn Auth>,

/// Tenant ID used only in Databend Cloud management mode.
/// This is NOT for specifying tenant in normal usage.
tenant: Option<String>,
warehouse: Mutex<Option<String>>,
session_state: Mutex<SessionState>,
Expand Down Expand Up @@ -311,6 +313,8 @@ impl APIClient {
};
client.set_presign_mode(presign_mode);
}
// NOTE: `tenant` is only used in Databend Cloud management mode.
// It is not intended for daily use to specify a tenant.
"tenant" => {
client.tenant = Some(v.to_string());
}
Expand Down
4 changes: 4 additions & 0 deletions driver/src/flight_sql.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,8 @@ struct Args {
user: String,
password: SensitiveString,
database: Option<String>,
/// Tenant ID used only in Databend Cloud management mode.
/// This is NOT for specifying tenant in normal usage.
tenant: Option<String>,
warehouse: Option<String>,
tls: bool,
Expand Down Expand Up @@ -284,6 +286,8 @@ impl Args {
let mut scheme = "https";
for (k, v) in u.query_pairs() {
match k.as_ref() {
// NOTE: `tenant` is only used in Databend Cloud management mode.
// It is not intended for daily use to specify a tenant.
"tenant" => args.tenant = Some(v.to_string()),
"warehouse" => args.warehouse = Some(v.to_string()),
"sslmode" => match v.as_ref() {
Expand Down
Loading