Referência da API Java para o Databricks JDBC Driver

Este artigo fornece documentação de referência de API para o Databricks JDBC Driver, versão 3 e superior.

Interface IDatabricksConnection

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

Pacote: com.databricks.jdbc.api

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

getConnectionId
String getConnectionId() throws SQLException Retorna um identificador para a conexão de sessão. Devoluções: Um String que representa a conexão para a sessão subjacente da execução.

IDatabricksInterface do driver

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.

fecharConexão
void closeConnection(String url, Properties info, String connectionId) throws SQLException Fecha a conexão para o ID de ligação especificado e a URL de ligação JDBC. Devoluções: 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. Devoluções: Um IExecutionStatus que representa o status da execução

getStatementId
String getStatementId() throws SQLException Retorna o ID da instrução associada da execução assíncrona. Devoluções: Um String que é o ID da instrução da execução

Interface IDatabricksStatement

Descreve 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 executar. Devoluções: Um ResultSet que representa os resultados do SQL executado

obterResultadoExecucao
ResultSet getExecutionResult() throws SQLException Busca um status e uma resposta para um comando SQL já executado e gera erro se nenhum comando tiver sido executado. Este método pode ser chamado várias vezes para sondar o estado de execução. Devoluções: Um ResultSet que representa os resultados do SQL executado

Interface IDatabricksVolumeClient

Descreve métodos para gerenciar arquivos em volumes do Catálogo 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 uma pasta) no volume do Catálogo Unity. O prefixo deve fazer 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 Catálogo Unity do armazenamento em nuvem. prefix - o prefixo para verificar a existência junto com o caminho relativo a partir do volume como diretório raiz. caseSensitive - se a verificação deve ou não diferenciar maiúsculas de minúsculas. Devoluções: Um booleano 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 do Catálogo 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 Catálogo Unity do armazenamento em nuvem. objectPath - o caminho do objeto (ficheiro) a partir do volume, considerando o diretório raiz, para verificar a existência dentro do volume (em qualquer subpasta). caseSensitive - um valor booleano que indica se a verificação deve ou não diferenciar maiúsculas de minúsculas. Devoluções: Um booleano que indica se o objeto existe ou não.

volumeExiste

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Determina se existe um volume específico no catálogo e esquema determinados. O volume deve 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 cuja existência se pretende verificar. caseSensitive um booleano indicando se a verificação deve diferenciar entre maiúsculas e minúsculas ou não. Devoluções: Um booleano que indica se o volume existe ou não.

listarObjetos

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Retorna a lista de todos os nomes de arquivos no volume do Catálogo Unity que começam com um prefixo especificado. O prefixo deve ser uma parte do caminho do ficheiro do volume, tendo como base 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 ficheiros a listar. Isso inclui o caminho relativo do volume como o diretório raiz. caseSensitive - um valor booleano que indica se a verificação deve ou não diferenciar maiúsculas de minúsculas. Devoluções: Uma lista de cadeias de caracteres que indicam os nomes de arquivos 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 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 (ficheiro) a partir do volume como diretório raiz. localPath - o caminho local onde os dados recuperados devem ser armazenados. Devoluções: Um valor booleano que indica o GET status da operação.

getObject (fluxo)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Recupera um objeto como fluxo de entrada a partir do volume do Catálogo 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 (ficheiro) a partir do volume como diretório raiz. Devoluções: 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 dentro de um volume do Catálogo 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 onde o objeto (ficheiro) deve ser carregado a partir do volume, que atua como diretório raiz. localPath O caminho local de onde os dados devem ser carregados. toOverwrite Um booleano que indica se o objeto deve ser sobrescrito se já existir. Devoluções: Um valor booleano 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 dentro de um volume do Catálogo 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 onde o objeto (arquivo) deve ser carregado do volume como o diretório raiz. inputStream - o fluxo de entrada a partir do qual os dados devem ser carregados. contentLength - o comprimento do fluxo de entrada. toOverwrite Um booleano que indica se o objeto deve ser sobrescrito se já existir. Devoluções: Um valor booleano que indica o status da operação PUT.

eliminarObjeto

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Remove um objeto de um caminho especificado dentro de um volume do Catálogo 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. Devoluções: Um valor booleano que indica o status da operação DELETE.

IDatabricksInterface geoespacial

Descreve métodos para trabalhar com tipos de dados geoespaciais (GEOMETRIA e GEOGRAFIA). Esta interface é expandida pelas interfaces de marcadores IGeometry e IGeography para objetos geoespaciais específicos de tipo.

Pacote: com.databricks.jdbc.api

getWKT
String getWKT() Devolve a representação Well-Known Text (WKT) do objeto geoespacial. Devoluções: Uma String contendo a representação WKT sem prefixo SRID.

getWKB
byte[] getWKB() Devolve a representação Well-Known Binária (WKB) compatível com OGC do objeto geoespacial. Devoluções: Um array de bytes contendo os dados WKB.

getSRID
int getSRID() Devolve o Identificador do Sistema de Referência Espacial (SRID) do objeto geoespacial. Devoluções: Um inteiro que representa o valor SRID (0 se não especificado).

obterTipo
String getType() Devolve o nome do tipo geoespacial. Devoluções: Uma String que é ou GEOMETRY ou GEOGRAPHY.

Enum ExecutionState

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

Pacote: com.databricks.jdbc.api

RUNNING	A instrução está sendo executada 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	O comunicado foi encerrado

Interface IExecutionStatus

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

Pacote: com.databricks.jdbc.api

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

getSqlState
String getSqlState() throws SQLException Se estiver definido, retorna o código SQLState para um status de falha. Devoluções: Um String que é o código SQLState

obterMensagemDeErro
String getErrorMessage() throws SQLException Retorna a mensagem de erro de uma execução com falha. Devoluções: Um String que é a mensagem de erro.