Package com.databricks.jdbc.dbclient

Interface IDatabricksClient

All Known Implementing Classes:

DatabricksSdkClient, DatabricksThriftServiceClient

public interface IDatabricksClient

Interface for Databricks client which abstracts the integration with Databricks server.

Method Summary

Modifier and Type	Method	Description
void	cancelStatement(StatementId statementId)	Cancels a statement in Databricks server
default boolean	checkStatementAlive(StatementId statementId)	Checks the status of a statement without fetching results.
void	closeStatement(StatementId statementId)	Closes a statement in Databricks server
ImmutableSessionInfo	createSession(IDatabricksComputeResource computeResource, String catalog, String schema, Map<String,String> sessionConf)	Creates a new session for given warehouse-Id, catalog and session.
void	deleteSession(ImmutableSessionInfo sessionInfo)	Deletes a session for given session-Id
DatabricksResultSet	executeStatement(String sql, IDatabricksComputeResource computeResource, Map<Integer,ImmutableSqlParameter> parameters, StatementType statementType, IDatabricksSession session, IDatabricksStatementInternal parentStatement, MetadataOperationType metadataOperationType)	Executes a statement in Databricks server
DatabricksResultSet	executeStatementAsync(String sql, IDatabricksComputeResource computeResource, Map<Integer,ImmutableSqlParameter> parameters, IDatabricksSession session, IDatabricksStatementInternal parentStatement)	Executes a statement in Databricks server asynchronously
IDatabricksConnectionContext	getConnectionContext()
com.databricks.sdk.core.DatabricksConfig	getDatabricksConfig()	Retrieves underlying DatabricksConfig
TFetchResultsResp	getMoreResults(IDatabricksStatementInternal parentStatement)
ChunkLinkFetchResult	getResultChunks(StatementId statementId, long chunkIndex, long chunkStartRowOffset)	Fetches the chunk links for given chunk index and statement-Id.
ResultData	getResultChunksData(StatementId statementId, long chunkIndex)	Fetches the result data for given chunk index and statement-Id.
DatabricksResultSet	getStatementResult(StatementId statementId, IDatabricksSession session, IDatabricksStatementInternal parentStatement)	Fetches result for underlying statement-Id
void	resetAccessToken(String newAccessToken)	Update the access token based on new value provided by the customer

Method Detail

createSession

ImmutableSessionInfo createSession(IDatabricksComputeResource computeResource,
                                   String catalog,
                                   String schema,
                                   Map<String,String> sessionConf)
                            throws SQLException

Creates a new session for given warehouse-Id, catalog and session.

Parameters:

computeResource - underlying SQL-warehouse or all-purpose cluster

catalog - for the session

schema - for the session

sessionConf - session configuration

Returns:

created session

Throws:

SQLException

deleteSession

void deleteSession(ImmutableSessionInfo sessionInfo)
            throws SQLException

Deletes a session for given session-Id

Parameters:

sessionInfo - for which the session should be deleted

Throws:

SQLException

executeStatement

DatabricksResultSet executeStatement(String sql,
                                     IDatabricksComputeResource computeResource,
                                     Map<Integer,ImmutableSqlParameter> parameters,
                                     StatementType statementType,
                                     IDatabricksSession session,
                                     IDatabricksStatementInternal parentStatement,
                                     MetadataOperationType metadataOperationType)
                              throws SQLException

Executes a statement in Databricks server

Parameters:

sql - SQL statement that needs to be executed

computeResource - underlying SQL-warehouse or all-purpose cluster

parameters - SQL parameters for the statement

statementType - type of statement (metadata, update or generic SQL)

session - underlying session

parentStatement - statement instance if called from a statement

metadataOperationType - optional metadata operation type for CP-side logging (e.g., GET_TABLES, GET_COLUMNS). Pass null for non-metadata operations. When provided, adds X-Databricks-Metadata-Operation-Type header to help distinguish metadata operations from regular SQL queries in logs.

Returns:

response for statement execution

Throws:

SQLException

executeStatementAsync

DatabricksResultSet executeStatementAsync(String sql,
                                          IDatabricksComputeResource computeResource,
                                          Map<Integer,ImmutableSqlParameter> parameters,
                                          IDatabricksSession session,
                                          IDatabricksStatementInternal parentStatement)
                                   throws SQLException

Executes a statement in Databricks server asynchronously

Parameters:

sql - SQL statement that needs to be executed

computeResource - underlying SQL-warehouse or all-purpose cluster

parameters - SQL parameters for the statement

session - underlying session

parentStatement - statement instance if called from a statement

Returns:

response for statement execution

Throws:

SQLException

closeStatement

void closeStatement(StatementId statementId)
             throws DatabricksSQLException

Closes a statement in Databricks server

Parameters:

statementId - statement which should be closed

Throws:

DatabricksSQLException

cancelStatement

void cancelStatement(StatementId statementId)
              throws DatabricksSQLException

Cancels a statement in Databricks server

Parameters:

statementId - statement which should be aborted

Throws:

DatabricksSQLException

checkStatementAlive

default boolean checkStatementAlive(StatementId statementId)
                             throws SQLException

Checks the status of a statement without fetching results. Used for heartbeat polling to keep server-side operation state alive during slow result consumption.

Parameters:

statementId - statement to check status for

Returns:

true if the statement is still in a non-terminal state (alive), false if terminal

Throws:

SQLException

getStatementResult

DatabricksResultSet getStatementResult(StatementId statementId,
                                       IDatabricksSession session,
                                       IDatabricksStatementInternal parentStatement)
                                throws SQLException

Fetches result for underlying statement-Id

Parameters:

statementId - statement which should be checked for status

session - underlying session

parentStatement - statement instance

Throws:

SQLException

getResultChunks

ChunkLinkFetchResult getResultChunks(StatementId statementId,
                                     long chunkIndex,
                                     long chunkStartRowOffset)
                              throws SQLException

Fetches the chunk links for given chunk index and statement-Id.

For SEA clients, the chunkIndex is used to identify which chunk to fetch. For Thrift clients, the rowOffset is used with FETCH_ABSOLUTE orientation to seek to the correct position.

The returned ChunkLinkFetchResult contains the chunk links and continuation information:

• SEA: hasMore derived from last link's nextChunkIndex
• Thrift: hasMore from server's hasMoreRows flag, nextRowOffset for continuation

Parameters:

statementId - statement-Id for which chunk should be fetched

chunkIndex - chunkIndex for which chunk should be fetched

chunkStartRowOffset - the row offset where the chunk starts in the result set

Throws:

SQLException

getResultChunksData

ResultData getResultChunksData(StatementId statementId,
                               long chunkIndex)
                        throws DatabricksSQLException

Fetches the result data for given chunk index and statement-Id.

Parameters:

statementId - statement-Id for which chunk data should be fetched

chunkIndex - chunkIndex for which chunk data should be fetched

Returns:

ResultData containing the chunk's data array and metadata

Throws:

DatabricksSQLException

getConnectionContext

IDatabricksConnectionContext getConnectionContext()

resetAccessToken

void resetAccessToken(String newAccessToken)

Update the access token based on new value provided by the customer

Parameters:

newAccessToken - new access token value

getMoreResults

TFetchResultsResp getMoreResults(IDatabricksStatementInternal parentStatement)
                          throws SQLException

Throws:

SQLException

getDatabricksConfig

com.databricks.sdk.core.DatabricksConfig getDatabricksConfig()

Retrieves underlying DatabricksConfig