diff --git a/README.md b/README.md index 6493215e..e470b9a3 100644 --- a/README.md +++ b/README.md @@ -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. | diff --git a/core/src/client.rs b/core/src/client.rs index 4f07717a..41be95bd 100644 --- a/core/src/client.rs +++ b/core/src/client.rs @@ -112,6 +112,8 @@ pub struct APIClient { auth: Arc, + /// Tenant ID used only in Databend Cloud management mode. + /// This is NOT for specifying tenant in normal usage. tenant: Option, warehouse: Mutex>, session_state: Mutex, @@ -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()); } diff --git a/driver/src/flight_sql.rs b/driver/src/flight_sql.rs index 32d0d6b8..72c2b28c 100644 --- a/driver/src/flight_sql.rs +++ b/driver/src/flight_sql.rs @@ -240,6 +240,8 @@ struct Args { user: String, password: SensitiveString, database: Option, + /// Tenant ID used only in Databend Cloud management mode. + /// This is NOT for specifying tenant in normal usage. tenant: Option, warehouse: Option, tls: bool, @@ -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() {