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

Este artigo fornece a documentação de referência API para o driverDatabricks JDBC (OSS).

Interface de conexão IDatabricksConnection

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

pacote: com.databricks.jdbc.api

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

Obter ID de conexão
String getConnectionId() throws SQLException Retorna um identificador para a conexão da sessão. Devoluções: 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.

Fechar conexão
void closeConnection(String url, Properties info, String connectionId) throws SQLException Fecha a conexão para o ID de conexão e o URL de conexão JDBC especificados. Devoluções: Nenhuma

Interface do conjunto de resultados do IDatabricksResultSet

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

pacote: com.databricks.jdbc.api

Obter status de execução
IExecutionStatus getExecutionStatus() throws SQLException Retorna o status da execução. Devoluções: Um IExecutionStatus que representa o status da execução

Obter ID da declaração
String getStatementId() throws SQLException Retorna o ID da declaração associado à execução assíncrona. Devoluções: Uma cadeia de caracteres que é o ID da declaração da execução

Interface de declaração de tijolos de dados

Descreve métodos para executar e lidar com uma consulta assíncrona.

pacote: com.databricks.jdbc.api

Executar uma sincronização
ResultSet executeAsync(String sql) throws SQLException Executa um comando SQL em modo assíncrono. Parâmetros: sql - o comando a ser executado. Devoluções: Um ResultSet que representa os resultados do SQL executado

Obter resultado da execução
ResultSet getExecutionResult() throws SQLException Obtém um status e uma resposta para um comando SQL já executado e gera um erro se nenhum comando tiver sido executado. Esse método pode ser chamado várias vezes para pesquisar o status 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 Unity Catalog.

pacote: com.databricks.jdbc.api

O prefixo existe

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 Unity Catalog. 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 Unity Catalog do armazenamento em nuvem. prefix - o prefixo para verificar a existência junto com o caminho relativo do volume como diretório raiz. caseSensitive - se o cheque deve diferenciar maiúsculas de minúsculas ou não. Devoluções: Um booleano que indica se o prefixo existe ou não.

O objeto existe

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Determina se um objeto específico (arquivo) existe no volume do Unity Catalog. 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 em nuvem. objectPath - o caminho do objeto (arquivo) do volume como diretório raiz para verificar a existência dentro do volume (dentro de qualquer subpasta). caseSensitive - um booleano que indica se a verificação deve ser sensível a maiúsculas e minúsculas ou não. Devoluções: Um booleano que indica se o objeto existe ou não.

O volume existe

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 fornecidos. 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 a ser verificado. caseSensitive um booleano que indica se a verificação deve ser sensível a maiúsculas e minúsculas ou não. Devoluções: Um booleano que indica se o volume existe ou não.

Listar objetos

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 Unity Catalog que começam com um prefixo especificado. O prefixo deve fazer parte do caminho do arquivo do volume como 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 de UC do armazenamento em nuvem. prefix - o prefixo dos nomes dos arquivos a serem listados. Isso inclui o caminho relativo do volume como o diretório raiz. caseSensitive - um booleano que indica se a verificação deve ser sensível a maiúsculas e minúsculas ou não. Devoluções: Uma lista de strings indicando 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 Unity Catalog 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 de UC do armazenamento em nuvem. objectPath - o caminho do objeto (arquivo) 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 status das operações GET.

getObject (transmissão)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Recupera um objeto como uma transmissão de entrada do volume 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 de UC do armazenamento em nuvem. objectPath - o caminho do objeto (arquivo) do volume como diretório raiz. Devoluções: Uma instância da entidade de transmissão de entrada.

PutObject (arquivo)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Faz o upload de dados de um caminho local para um caminho especificado em um 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 de UC do armazenamento em nuvem. objectPath o caminho de destino para onde o objeto (arquivo) deve ser carregado a partir 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 sobrescrito caso já exista. Devoluções: Um valor booleano que indica o status das operações PUT.

putObject (transmissão)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException carregar dados de uma transmissão de entrada para um caminho especificado em um volume 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 de UC do armazenamento em nuvem. objectPath - o caminho de destino para onde o objeto (arquivo) deve ser carregado do volume como o diretório raiz. inputStream - a transmissão de entrada de onde os dados devem ser carregados. contentLength - o comprimento da transmissão de entrada. toOverwrite um booleano que indica se o objeto deve ser sobrescrito caso já exista. Devoluções: Um valor booleano que indica o status das operações PUT.

Excluir objeto

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Remove um objeto de um caminho especificado em um 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 de 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 das operações 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á sendo executada no servidor
PENDING	A declaração ainda não foi executada no servidor
SUCCEEDED	A execução da declaração foi bem-sucedida
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

Obter estado de execuçã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

Obter SQL State
String getSqlState() throws SQLException Se estiver definido, retornará o código SQLState para um status de falha. Devoluções: Uma cadeia de caracteres que é o código SQLState

Receber mensagem de erro
String getErrorMessage() throws SQLException Retorna a mensagem de erro de uma execução falhada. Devoluções: Uma cadeia de caracteres que é a mensagem de erro.