Skip to content

Add support for default_profile in [__settings__] section - #698

Merged
simonfaltum merged 16 commits into
mainfrom
default-profile
Apr 16, 2026
Merged

Add support for default_profile in [__settings__] section#698
simonfaltum merged 16 commits into
mainfrom
default-profile

Conversation

@simonfaltum

@simonfaltum simonfaltum commented Mar 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

  • When no profile is explicitly configured, check [__settings__].default_profile in ~/.databrickscfg before falling back to the DEFAULT section
  • Aligns the Java SDK with the CLI's auth switch feature

Profile resolution order:

  1. Explicit profile (--profile flag, env var, or programmatic config)
  2. [__settings__].default_profile (new)
  3. [DEFAULT] section (legacy fallback)

Changes

ConfigLoader.java: Extracted a resolveProfile method that encapsulates all profile resolution logic (explicit, [__settings__].default_profile, DEFAULT fallback). Returns the resolved profile name and whether it is a silent fallback. loadFromConfig no longer needs to know about __settings__ at all, replacing two booleans (hasExplicitProfile, hasDefaultProfileSetting) with a single isFallback flag.

Using __settings__ as a profile name (either via --profile or default_profile) now returns a specific error ("reserved section name") instead of the generic "has no profile configured".

DefaultProfileTest.java: 8 test scenarios covering resolution, precedence, legacy fallback, empty settings, explicit override, settings-not-a-profile (both via default_profile and explicit --profile), and nonexistent profile error.

Test plan

  • default_profile resolves correctly
  • default_profile takes precedence over [DEFAULT]
  • Legacy fallback when no [__settings__]
  • Legacy fallback when default_profile is empty
  • [__settings__] is not treated as a profile (via default_profile)
  • [__settings__] is not treated as a profile (via explicit --profile)
  • Explicit --profile overrides default_profile
  • default_profile pointing to nonexistent section throws error

@simonfaltum @claude
Add support for default_profile in [__settings__] section
39ecf38 
Adds support for the __settings__ section in .databrickscfg, enabling
default_profile to specify which profile to use when none is explicitly
set. The resolved profile is written back to DatabricksConfig so
downstream consumers (e.g. DatabricksCliCredentialsProvider) see it.

Rejects __settings__ as a profile target to prevent self-referencing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@simonfaltum
Reject __settings__ as a reserved profile target
be0e584 
Keep default_profile resolution aligned with the other SDKs by preserving the resolved profile name and surfacing bad settings targets instead of silently falling back.
@simonfaltum
simonfaltum marked this pull request as ready for review March 11, 2026 20:19
@simonfaltum
Extract resolveProfile to simplify loadFromConfig
c417dc7 
Move all profile resolution logic (explicit, __settings__, DEFAULT
fallback) into a single resolveProfile method that returns the
profile name and whether it is a silent fallback. This replaces the
two-boolean pattern (hasExplicitProfile, hasDefaultProfileSetting)
with a clearer isFallback flag, and keeps __settings__ knowledge
out of loadFromConfig entirely.

Also improves error messages when __settings__ is used as a profile
name: now says "reserved section name" instead of the generic
"has no __settings__ profile configured".

Co-authored-by: Isaac
@simonfaltum
simonfaltum requested review from renaudhartert-db and removed request for parthban-db and renaudhartert-db March 22, 2026 07:10
hectorcast-db
hectorcast-db reviewed Mar 26, 2026
View reviewed changes
Comment thread databricks-sdk-java/src/main/java/com/databricks/sdk/core/ConfigLoader.java Outdated
@simonfaltum
Replace String[] with ResolvedProfile inner class
a55e191 
Address review feedback: use a typed inner class instead of a String
array to represent the resolved profile name and fallback flag.

Co-authored-by: Isaac
@simonfaltum
Merge remote-tracking branch 'origin/main' into default-profile
3595fae 
# Conflicts:
#	NEXT_CHANGELOG.md
@simonfaltum
Route CI Maven resolution through Databricks proxy
c200b12 
Maven Central is blocked on Databricks network (including GH Actions
runners). Add proxy mirror config to all CI workflows so dependency
resolution goes through maven-proxy.dev.databricks.com.

For the release workflow, a Python script injects the mirror into the
settings.xml that setup-java creates (to preserve server credentials).

Co-authored-by: Isaac
@github-actions

github-actions Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-java

Inputs:

  • PR number: 698
  • Commit SHA: ef89f21c0ff5ebfd8b5306d19488fb509b82a21c

Checks will be approved automatically on success.

@simonfaltum
simonfaltum added this pull request to the merge queue Apr 16, 2026
Merged via the queue into main with commit bfb25d4 Apr 16, 2026
15 of 16 checks passed
@simonfaltum
simonfaltum deleted the default-profile branch April 16, 2026 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hectorcast-db hectorcast-db hectorcast-db approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@simonfaltum @hectorcast-db