databricks::AuthConfig Struct Reference

Core authentication configuration shared across all Databricks features. More...

#include <config.h>

Public Member Functions
bool	is_valid () const
	Validate that all required fields are set.

Static Public Member Functions
static AuthConfig	from_profile (const std::string &profile="DEFAULT")
	Load authentication configuration from Databricks CLI profile.
static AuthConfig	from_env ()
	Load authentication configuration from environment variables.
static AuthConfig	from_environment (const std::string &profile="DEFAULT")
	Load authentication configuration from all available sources.

Public Attributes
std::string	host
	Databricks workspace URL (e.g., "https://your-workspace.cloud.databricks.com")
std::string	token
	Authentication token (personal access token or OAuth token)
int	timeout_seconds = 60
	Request timeout in seconds (default: 60)

Detailed Description

Core authentication configuration shared across all Databricks features.

This configuration contains the fundamental authentication and connection settings needed to connect to Databricks. It can be shared across multiple client types (SQL, Workspace, Delta, etc.).

Definition at line 15 of file config.h.

Member Function Documentation

from_env()

static AuthConfig databricks::AuthConfig::from_env ( )

static

Load authentication configuration from environment variables.

Reads from:

• DATABRICKS_HOST or DATABRICKS_SERVER_HOSTNAME
• DATABRICKS_TOKEN or DATABRICKS_ACCESS_TOKEN
• DATABRICKS_TIMEOUT (optional)

Returns

AuthConfig populated from environment variables

Exceptions

std::runtime_error

if required environment variables are not set

from_environment()

static AuthConfig databricks::AuthConfig::from_environment ( const std::string &  profile = "DEFAULT" )

static

Load authentication configuration from all available sources.

Precedence (highest to lowest):

1. Profile configuration file (~/.databrickscfg) - if complete, stops here
2. Environment variables - used as fallback if profile missing/incomplete

Parameters

profile

The profile name to try loading (default: "DEFAULT")

Returns

AuthConfig populated from available sources

Exceptions

std::runtime_error

if no valid configuration is found

from_profile()

static AuthConfig databricks::AuthConfig::from_profile ( const std::string &  profile = "DEFAULT" )

static

Load authentication configuration from Databricks CLI profile.

Reads from ~/.databrickscfg file and loads the specified profile section.

Parameters

profile

The profile name to load (default: "DEFAULT")

Returns

AuthConfig populated from the profile

Exceptions

std::runtime_error

if profile is not found or incomplete

is_valid()

bool databricks::AuthConfig::is_valid

(

)

const

Validate that all required fields are set.

Returns

true if valid, false otherwise

Member Data Documentation

host

std::string databricks::AuthConfig::host

Databricks workspace URL (e.g., "https://your-workspace.cloud.databricks.com")

Definition at line 17 of file config.h.

timeout_seconds

int databricks::AuthConfig::timeout_seconds = 60

Request timeout in seconds (default: 60)

Definition at line 19 of file config.h.

token

std::string databricks::AuthConfig::token

Authentication token (personal access token or OAuth token)

Definition at line 18 of file config.h.

---

The documentation for this struct was generated from the following file:

• include/databricks/core/config.h