databricks::Client::Builder Class Reference

Builder pattern for constructing Client with modular configuration. More...

#include <client.h>

Public Member Functions
	Builder ()
Builder &	with_auth (const AuthConfig &auth)
	Set authentication configuration.
Builder &	with_sql (const SQLConfig &sql)
	Set SQL configuration.
Builder &	with_pooling (const PoolingConfig &pooling)
	Set connection pooling configuration (optional)
Builder &	with_environment_config (const std::string &profile="DEFAULT")
	Load configuration from environment (profile + env vars)
Builder &	with_auto_connect (bool enable=true)
	Enable auto-connect (connects immediately on build)
Builder &	with_retry (const RetryConfig &retry)
	Set retry configuration for automatic error recovery.
Client	build ()
	Build the Client.

Detailed Description

Builder pattern for constructing Client with modular configuration.

The Builder provides a fluent interface for configuring the Client. It ensures that all required configuration is provided before building.

Definition at line 73 of file client.h.

Constructor & Destructor Documentation

Builder()

databricks::Client::Builder::Builder

(

)

Member Function Documentation

build()

Client databricks::Client::Builder::build

(

)

Build the Client.

Returns

Client instance

Exceptions

std::runtime_error

if required configuration is missing

with_auth()

Builder & databricks::Client::Builder::with_auth

(

const AuthConfig &

auth

)

Set authentication configuration.

Parameters

auth	Authentication configuration

Returns

Builder reference for chaining

with_auto_connect()

Builder & databricks::Client::Builder::with_auto_connect

(

bool

enable = true

)

Enable auto-connect (connects immediately on build)

Parameters

enable

If true, connects immediately; if false, lazy connection (default: false)

Returns

Builder reference for chaining

with_environment_config()

Builder & databricks::Client::Builder::with_environment_config

(

const std::string &

profile = "DEFAULT"

)

Load configuration from environment (profile + env vars)

This is a convenience method that loads auth and SQL config from:

1. ~/.databrickscfg profile (if exists)
2. Environment variables (as fallback)

Parameters

profile

Profile name to load (default: "DEFAULT")

Returns

Builder reference for chaining

Exceptions

std::runtime_error

if configuration cannot be loaded

with_pooling()

Builder & databricks::Client::Builder::with_pooling

(

const PoolingConfig &

pooling

)

Set connection pooling configuration (optional)

Parameters

pooling

Pooling configuration

Returns

Builder reference for chaining

with_retry()

Builder & databricks::Client::Builder::with_retry

(

const RetryConfig &

retry

)

Set retry configuration for automatic error recovery.

Configures how the client handles transient failures like connection timeouts and network errors. When enabled, failed operations will be automatically retried with exponential backoff.

Parameters

retry

Retry configuration

Returns

Builder reference for chaining

databricks::RetryConfig retry;
retry.max_attempts = 5;
retry.initial_backoff_ms = 200;
 
auto client = databricks::Client::Builder()
    .with_environment_config()
    .with_retry(retry)
    .build();

with_sql()

Builder & databricks::Client::Builder::with_sql

(

const SQLConfig &

sql

)

Set SQL configuration.

Parameters

sql	SQL-specific configuration

Returns

Builder reference for chaining

---

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

• include/databricks/core/client.h