Referência da API Java para o Driver JDBC (OSS) do Databricks

Este artigo fornece a documentação de referência da API para o Driver JDBC (OSS) do Databricks.

Interface IDatabricksConnection

Descreve métodos para recuperar identificadores de conexão e execução de instruções.

Pacote: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Retorna um identificador para uma determinada ID de instrução. Retorna: Um IDatabricksStatement para lidar com uma execução existente.

getConnectionId
String getConnectionId() throws SQLException Retorna um identificador para a conexão de sessão. Retorna: Uma cadeia de caracteres que representa a conexão para a sessão subjacente da execução.

Interface IDatabricksDriver

Descreve métodos para gerenciar a conexão do driver.

Pacote: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver estende com.databricks.client.jdbc.IDatabricksDriver e java.sql.Driver.

closeConnection
void closeConnection(String url, Properties info, String connectionId) throws SQLException Fecha a conexão para a ID de conexão especificada e a URL de conexão JDBC. Retorna: Nenhum

Interface IDatabricksResultSet

Descreve métodos para recuperar resultados de uma consulta assíncrona.

Pacote: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Retorna o status da execução. Retorna: Um IExecutionStatus que representa o status da execução

getStatementId
String getStatementId() throws SQLException Retorna a ID da instrução associada da execução assíncrona. Retorna: Uma cadeia de caracteres que é a ID da instrução da execução

Interface IDatabricksStatement

Descreve os métodos para executar e manipular uma consulta assíncrona.

Pacote: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Executa um comando SQL no modo assíncrono. Parâmetros: sql - o comando a ser executado. Retorna: Um ResultSet que representa os resultados do SQL executado

obterResultadoDeExecução
ResultSet getExecutionResult() throws SQLException Busca um status e uma resposta para um comando SQL já executado e lança um erro se nenhum comando tiver sido executado. Esse método pode ser chamado várias vezes para verificar o status de execução. Retorna: Um ResultSet que representa os resultados do SQL executado

Interface IDatabricksVolumeClient

Descreve métodos para gerenciar arquivos em volumes do Catálogo do Unity.

Pacote: com.databricks.jdbc.api

prefixoExiste

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Determina se existe um prefixo específico (estrutura semelhante a pasta) no volume do Catálogo do Unity. O prefixo deve ser uma parte do nome do arquivo. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume do Unity Catalog do armazenamento na nuvem. prefix – O prefixo para verificar a existência junto com o caminho relativo do volume como o diretório raiz. caseSensitive – indica se a verificação deve diferenciar maiúsculas de minúsculas. Retorna: Um booliano que indica se o prefixo existe ou não.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Determina se existe um objeto específico (arquivo) no volume catálogo do Unity. O objeto deve corresponder exatamente ao nome do arquivo. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume do Unity Catalog do armazenamento na nuvem. objectPath – O caminho do objeto (arquivo) do volume como o diretório raiz para verificar a existência dentro do volume (dentro de qualquer subpasta). caseSensitive - um booliano que indica se a verificação deve diferenciar maiúsculas de minúsculas ou não. Retorna: Um booliano que indica se o objeto existe ou não.

volumeExists

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Determina se existe um volume específico no catálogo e no esquema especificados. O volume precisa corresponder exatamente ao nome do volume. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volumeName – O nome do volume a ser verificado quanto à existência. caseSensitive um booliano que indica se a verificação deve diferenciar maiúsculas de minúsculas ou não. Retorna: Um booliano que indica se o volume existe ou não.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Retorna a lista de todos os nomes de arquivo no volume do Catálogo do Unity que começam com um prefixo especificado. O prefixo precisa ser uma parte do caminho do arquivo do volume como a raiz. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. prefix - o prefixo dos nomes de arquivo a serem listados. Inclui o caminho relativo do volume como o diretório raiz. caseSensitive - um booliano que indica se a verificação deve diferenciar maiúsculas de minúsculas ou não. Retorna: Uma lista de cadeias de caracteres que indicam os nomes de arquivo que começam com o prefixo especificado.

getObject (arquivo)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Recupera um objeto (arquivo) do volume do Catálogo do Unity e o armazena no caminho local especificado. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. objectPath - o caminho do objeto (arquivo) a partir do volume como diretório raiz. localPath - o caminho local em que os dados recuperados devem ser armazenados. Retorna: Um valor booliano que indica o status da operação GET.

getObject (fluxo)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Recupera um objeto como fluxo de entrada do volume do Unity Catalog. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. objectPath - o caminho do objeto (arquivo) a partir do volume como diretório raiz. Retorna: Uma instância da entidade de fluxo de entrada.

putObject (arquivo)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Carrega dados de um caminho local para um caminho especificado em um volume do Catálogo do Unity. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. objectPath o caminho de destino em que o objeto (arquivo) deve ser carregado do volume como o diretório raiz. localPath o caminho local de onde os dados devem ser carregados. toOverwrite um booleano que indica se o objeto deve ser substituído caso já exista. Retorna: Um valor booliano que indica o status da operação PUT.

putObject (fluxo)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Carrega dados de um fluxo de entrada para um caminho especificado em um volume do Catálogo do Unity. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. objectPath - o caminho de destino em que o objeto (arquivo) deve ser carregado do volume como o diretório raiz. inputStream - o fluxo de entrada de onde os dados devem ser carregados. contentLength - o comprimento do fluxo de entrada. toOverwrite um booleano que indica se o objeto deve ser substituído caso já exista. Retorna: Um valor booliano que indica o status da operação PUT.

excluirObjeto

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Remove um objeto de um caminho especificado em um volume do Catálogo do Unity. Parâmetros: catalog - o nome do catálogo do armazenamento em nuvem. schema - o nome do esquema do armazenamento em nuvem. volume - o nome do volume UC do armazenamento em nuvem. objectPath - o caminho do objeto (arquivo) do volume como o diretório raiz a ser excluído. Retorna: Um valor booliano que indica o status da operação DELETE.

Enumeração ExecutionState

Contém os estados de uma consulta assíncrona em execução.

Pacote: com.databricks.jdbc.api

RUNNING	A instrução está em execução no servidor
PENDING	A instrução ainda não foi executada no servidor
SUCCEEDED	A instrução foi executada com êxito
FAILED	A execução da instrução falhou
ABORTED	A declaração foi abortada
CLOSED	A declaração foi encerrada

Interface IExecutionStatus

Descreve métodos para recuperar o status de uma consulta assíncrona.

Pacote: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Retorna o estado do status de execução. Retorna: Um ExecutionState que representa o estado do status de execução

getSqlState
String getSqlState() throws SQLException Se estiver definido, retornará o código SQLState para um status com falha. Retorna: Uma cadeia de caracteres que é o código SQLState

getErrorMessage
String getErrorMessage() throws SQLException Retorna a mensagem de erro de uma execução com falha. Retorna: Uma cadeia de caracteres que é a mensagem de erro.