Namespaces
namespace	internal

Classes
struct	AuthConfig
	Core authentication configuration shared across all Databricks features. More...

struct	CatalogInfo
	Represents a Unity Catalog catalog. More...

class	Client
	Main client class for Databricks SQL operations. More...

struct	Cluster
	Represents a Databricks cluster. More...

struct	ClusterState
	Represents detailed state information for a cluster. More...

struct	ColumnInfo
	Represents column information. More...

class	Compute
	Client for interacting with the Databricks Clusters/Compute API. More...

class	ConnectionPool
	Thread-safe connection pool for managing Databricks connections. More...

struct	CreateCatalogRequest
	Configuration for creating a catalog. More...

struct	CreateSchemaRequest
	Configuration for creating a schema. More...

struct	Job
	Represents a Databricks job. More...

struct	JobRun
	Represents a specific execution (run) of a Databricks job. More...

class	Jobs
	Client for interacting with the Databricks Jobs API. More...

struct	PoolingConfig
	Connection pooling configuration (optional performance optimization) More...

struct	RetryConfig
	Retry configuration for automatic error recovery. More...

struct	SchemaInfo
	Represents a Unity Catalog schema. More...

struct	SQLConfig
	SQL-specific configuration for Databricks SQL operations. More...

struct	TableInfo
	Represents a Unity Catalog table. More...

class	UnityCatalog
	Client for interacting with the Databricks Unity Catalog API. More...

struct	UpdateCatalogRequest
	Configuration for updating a catalog. More...

struct	UpdateSchemaRequest
	Configuration for updating a schema. More...

Enumerations
enum class	ClusterStateEnum { PENDING , RUNNING , RESTARTING , RESIZING , TERMINATING , TERMINATED , ERROR , UNKNOWN }
	Enumeration of possible cluster lifecycle states. More...

enum class	CatalogTypeEnum { MANAGED_CATALOG , EXTERNAL_CATALOG , SYSTEM_CATALOG , UNKNOWN }
	Enumeration of catalog types. More...

enum class	TableTypeEnum { MANAGED , EXTERNAL , VIEW , MATERIALIZED_VIEW , STREAMING_TABLE , UNKNOWN }
	Enumeration of table types. More...

Functions
ClusterStateEnum	parse_cluster_state (const std::string &state_str)
	Parse a cluster state string into ClusterStateEnum.

std::string	cluster_state_to_string (ClusterStateEnum state)
	Convert ClusterStateEnum to string representation.

CatalogTypeEnum	parse_catalog_type (const std::string &type_str)
	Parse a catalog type string into CatalogTypeEnum.

std::string	catalog_type_to_string (CatalogTypeEnum type)
	Convert CatalogTypeEnum to string representation.

TableTypeEnum	parse_table_type (const std::string &type_str)
	Parse a table type string into TableTypeEnum.

std::string	table_type_to_string (TableTypeEnum type)
	Convert TableTypeEnum to string representation.

void	to_json (nlohmann::json &j, const CreateCatalogRequest &req)
	Convert CreateCatalogRequest to JSON.

void	to_json (nlohmann::json &j, const UpdateCatalogRequest &req)
	Convert UpdateCatalogRequest to JSON.

void	to_json (nlohmann::json &j, const CreateSchemaRequest &req)
	Convert CreateSchemaRequest to JSON.

void	to_json (nlohmann::json &j, const UpdateSchemaRequest &req)
	Convert UpdateSchemaRequest to JSON.

Enumeration Type Documentation

◆ CatalogTypeEnum

enum class databricks::CatalogTypeEnum

strong

Enumeration of catalog types.

Enumerator
MANAGED_CATALOG	Databricks-managed catalog.
EXTERNAL_CATALOG	External catalog (e.g., AWS Glue, Azure)
SYSTEM_CATALOG	System catalog.
UNKNOWN	Unknown catalog type.

Definition at line 15 of file unity_catalog_types.h.

◆ ClusterStateEnum

enum class databricks::ClusterStateEnum

strong

Enumeration of possible cluster lifecycle states.

Represents the various states a Databricks cluster can be in during its lifecycle.

Enumerator
PENDING	Cluster is being created.
RUNNING	Cluster is running and ready for use.
RESTARTING	Cluster is restarting.
RESIZING	Cluster is being resized.
TERMINATING	Cluster is being terminated.
TERMINATED	Cluster has been terminated.
ERROR	Cluster is in an error state.
UNKNOWN	Unknown or unrecognized state.

Definition at line 14 of file compute_types.h.

◆ TableTypeEnum

enum class databricks::TableTypeEnum

strong

Enumeration of table types.

Enumerator
MANAGED	Managed table.
EXTERNAL	External table.
VIEW	View.
MATERIALIZED_VIEW	Materialized view.
STREAMING_TABLE	Streaming table.
UNKNOWN	Unknown table type.

Definition at line 39 of file unity_catalog_types.h.

Function Documentation

◆ catalog_type_to_string()

std::string databricks::catalog_type_to_string ( CatalogTypeEnum type )

Convert CatalogTypeEnum to string representation.

Parameters

type	CatalogTypeEnum value

Returns: String representation of the catalog type

◆ cluster_state_to_string()

std::string databricks::cluster_state_to_string ( ClusterStateEnum state )

Convert ClusterStateEnum to string representation.

Parameters

state ClusterStateEnum value

Returns: String representation of the state

◆ parse_catalog_type()

CatalogTypeEnum databricks::parse_catalog_type ( const std::string & type_str )

Parse a catalog type string into CatalogTypeEnum.

Parameters

type_str String representation of the catalog type

Returns: CatalogTypeEnum corresponding to the string

◆ parse_cluster_state()

ClusterStateEnum databricks::parse_cluster_state ( const std::string & state_str )

Parse a cluster state string into ClusterStateEnum.

Parameters

state_str String representation of the cluster state

Returns: ClusterStateEnum corresponding to the string

◆ parse_table_type()

TableTypeEnum databricks::parse_table_type ( const std::string & type_str )

Parse a table type string into TableTypeEnum.

Parameters

type_str String representation of the table type

Returns: TableTypeEnum corresponding to the string

◆ table_type_to_string()

std::string databricks::table_type_to_string ( TableTypeEnum type )

Convert TableTypeEnum to string representation.

Parameters

type	TableTypeEnum value

Returns: String representation of the table type

◆ to_json() [1/4]

void databricks::to_json	(	nlohmann::json &	j,
		const CreateCatalogRequest &	req
	)

Convert CreateCatalogRequest to JSON.

◆ to_json() [2/4]

void databricks::to_json	(	nlohmann::json &	j,
		const CreateSchemaRequest &	req
	)

Convert CreateSchemaRequest to JSON.

◆ to_json() [3/4]

void databricks::to_json	(	nlohmann::json &	j,
		const UpdateCatalogRequest &	req
	)

Convert UpdateCatalogRequest to JSON.

◆ to_json() [4/4]

void databricks::to_json	(	nlohmann::json &	j,
		const UpdateSchemaRequest &	req
	)

Convert UpdateSchemaRequest to JSON.

Namespaces

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ CatalogTypeEnum

◆ ClusterStateEnum

◆ TableTypeEnum

Function Documentation

◆ catalog_type_to_string()

◆ cluster_state_to_string()

◆ parse_catalog_type()

◆ parse_cluster_state()

◆ parse_table_type()

◆ table_type_to_string()

◆ to_json() [1/4]

◆ to_json() [2/4]

◆ to_json() [3/4]

◆ to_json() [4/4]