Skip to content

Commit 30374cb

Browse files
committed
docs(thrift): clarify metricViewMetadata false ≡ omit in JSDoc
Address DA review note N4 on PR #397: the public type is `boolean` (not `true`-literal), but the wiring treats `false` and omitted identically. Spell that out in the JSDoc so callers don't expect `false` to clear a server-side default. Co-authored-by: Isaac Signed-off-by: Madhavendra Rathore <madhavendra.rathore@databricks.com>
1 parent 47e601a commit 30374cb

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

lib/contracts/IDBSQLSession.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ export type ExecuteStatementOptions = {
3333
* forwarded via the Thrift `confOverlay`. Applies to a single statement only;
3434
* does not persist across queries.
3535
*
36+
* Setting `false` is equivalent to omitting the option — both leave
37+
* `confOverlay` untouched and the server's session default applies. The
38+
* option is opt-in only; there is no way to explicitly clear a server
39+
* default from the client.
40+
*
3641
* Equivalent SEA wiring will route the same key through napi `statementConf`
3742
* once the kernel statement-options surface lands — until then this knob is
3843
* honored only on the Thrift backend.

0 commit comments

Comments
 (0)