Struct DatabricksBuilder 

pub struct DatabricksBuilder { /* private fields */ }

Builder for Databricks authentication configuration.

Auth resolution order (when no auth_type is forced):

1. Explicit with_credentials(provider) override.
2. PAT / static token (DATABRICKS_TOKEN / with_token()).
3. OAuth M2M (DATABRICKS_CLIENT_ID + DATABRICKS_CLIENT_SECRET).
4. env-oidc — OIDC token from env var (DATABRICKS_OIDC_TOKEN_ENV, default DATABRICKS_OIDC_TOKEN).
5. file-oidc — OIDC token from file (DATABRICKS_OIDC_TOKEN_FILEPATH).
6. Azure MSI fallback (if DATABRICKS_AZURE_RESOURCE_ID is set).
7. GCP service account token exchange (if GOOGLE_APPLICATION_CREDENTIALS is set).

If DATABRICKS_AUTH_TYPE is set (or with_auth_type() called), only the named auth type is attempted; an error is returned immediately if its required fields are absent.

.databrickscfg profile values are loaded as the lowest-priority source — env vars and code-level setters override them.

Implementations

impl DatabricksBuilder

pub fn new() -> Self

Create a new DatabricksBuilder with default values.

pub fn from_env() -> Self

Populate from environment variables and optionally a .databrickscfg profile.

Profile values from .databrickscfg (or DATABRICKS_CONFIG_FILE) are loaded first as the lowest-priority source. Environment variables override profile values.

Variables read: DATABRICKS_HOST, DATABRICKS_TOKEN, DATABRICKS_CLIENT_ID, DATABRICKS_CLIENT_SECRET, DATABRICKS_ACCOUNT_ID, DATABRICKS_AZURE_RESOURCE_ID, DATABRICKS_OAUTH_SCOPE, DATABRICKS_CONFIG_FILE, DATABRICKS_CONFIG_PROFILE, DATABRICKS_AUTH_TYPE, DATABRICKS_OIDC_TOKEN_ENV, DATABRICKS_OIDC_TOKEN_FILEPATH, GOOGLE_APPLICATION_CREDENTIALS.

pub fn with_config( self, key: DatabricksConfigKey, value: impl Into<String>, ) -> Self

Set an option via a key-value pair.

pub fn with_credentials( self, credentials: Arc<dyn CredentialProvider<Credential = DatabricksCredential>>, ) -> Self

Override credential resolution with a custom provider.

pub fn with_host(self, host: impl Into<String>) -> Self

Set the Databricks host URL.

pub fn with_token(self, token: impl Into<String>) -> Self

Set a static PAT or bearer token.

pub fn with_auth_type(self, auth_type: impl Into<String>) -> Self

Force a specific auth type (e.g. "pat", "oauth-m2m", "env-oidc", "file-oidc").

pub fn with_oidc_token_env(self, env_var: impl Into<String>) -> Self

Set the env var name that holds an OIDC token (default: DATABRICKS_OIDC_TOKEN).

pub fn with_oidc_token_filepath(self, path: impl Into<String>) -> Self

Set the file path to an OIDC token.

pub fn with_retry(self, retry_config: RetryConfig) -> Self

Set the retry configuration.

pub fn with_client_options(self, options: ClientOptions) -> Self

Set the HTTP client options.

pub fn build(self, runtime: Option<&Handle>) -> Result<DatabricksConfig>

Build a DatabricksConfig.

If runtime is provided, HTTP I/O for credential refresh is spawned on that runtime.

Trait Implementations

impl Clone for DatabricksBuilder

fn clone(&self) -> DatabricksBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatabricksBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DatabricksBuilder

fn default() -> DatabricksBuilder

Returns the “default value” for a type.