Informazioni di riferimento sulle API Java per il driver JDBC di Databricks

Questo articolo fornisce la documentazione di riferimento sulle API per il driver JDBC di Databricks, versione 3 e successive.

Interfaccia IDatabricksConnection

I metodi per recuperare gli handle di connessione e di esecuzione delle istruzioni sono descritti.

Pacchetto: com.databricks.jdbc.api

ottieniDichiarazione
IDatabricksStatement getStatement(String statementId) throws SQLException Restituisce un handle per un ID di dichiarazione specificato. Restituisce: Oggetto IDatabricksStatement per la gestione di un'esecuzione esistente.

getConnectionId
String getConnectionId() throws SQLException Restituisce un handle per la connessione di sessione. Restituisce: Stringa che rappresenta la connessione per la sessione sottostante dell'esecuzione.

Interfaccia IDatabricksDriver

Descrive i metodi per gestire la connessione al driver.

Pacchetto: com.databricks.client.jdbc

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

closeConnection (chiudiConnessione)
void closeConnection(String url, Properties info, String connectionId) throws SQLException Chiude la connessione per l'ID di connessione specificato e l'URL di connessione JDBC. Restituisce: Nessuno

Interfaccia IDatabricksResultSet

Descrive i metodi per recuperare i risultati di una query asincrona.

Pacchetto: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Restituisce lo stato dell'esecuzione. Restituisce: IExecutionStatus che rappresenta lo stato dell'esecuzione

getStatementId
String getStatementId() throws SQLException Restituisce l'ID associato all'esecuzione asincrona dell'istruzione. Restituisce: Valore String che rappresenta l'ID istruzione dell'esecuzione

Interfaccia IDatabricksStatement

Descrive i metodi per eseguire e gestire una query asincrona.

Pacchetto: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Esegue un comando SQL in modalità asincrona. Parametri: sql : comando da eseguire. Restituisce: ResultSet che rappresenta i risultati di SQL eseguito

getExecutionResult
ResultSet getExecutionResult() throws SQLException Recupera uno stato e una risposta per un comando SQL già eseguito e genera un errore se non è stato eseguito alcun comando. Questo metodo può essere chiamato più volte per monitorare lo stato di esecuzione. Restituisce: ResultSet che rappresenta i risultati di SQL eseguito

Interfaccia IDatabricksVolumeClient

Descrive i metodi per gestire i file nei volumi del catalogo Unity.

Pacchetto: com.databricks.jdbc.api

prefissoEsiste

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Determina se esiste un prefisso specifico (struttura simile a una cartella) nel volume del catalogo Unity. Il prefisso deve far parte del nome del file. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume del catalogo Unity dell'archiviazione cloud. prefix - il prefisso per verificare l'esistenza insieme al percorso relativo dalla radice del volume come directory. caseSensitive - indica se il controllo deve fare distinzione tra maiuscole e minuscole o meno. Restituisce: Valore booleano che indica se il prefisso esiste o meno.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Determina se esiste un oggetto specifico (file) nel volume del catalogo Unity. L'oggetto deve corrispondere esattamente al nome del file. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume del catalogo Unity dell'archiviazione cloud. objectPath - il percorso dell'oggetto (file) dalla radice del volume per verificare l'esistenza all'interno del volume (compresa qualsiasi sottocartella). caseSensitive - valore booleano che indica se il controllo deve essere con distinzione tra maiuscole e minuscole o meno. Restituisce: Valore booleano che indica se l'oggetto esiste o meno.

volumeEsiste

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Determina se esiste un volume specifico nel catalogo e nello schema specificati. Il volume deve corrispondere esattamente al nome del volume. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volumeName : nome del volume per verificare l'esistenza. caseSensitive valore booleano che indica se il controllo deve fare distinzione tra maiuscole e minuscole o meno. Restituisce: Valore booleano che indica se il volume esiste o meno.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Restituisce l'elenco di tutti i nomi file nel volume del catalogo Unity che iniziano con un prefisso specificato. Il prefisso deve far parte del percorso del file dal volume come radice. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. prefix : prefisso dei nomi file da elencare. Questo include il percorso relativo a partire dal volume come directory radice. caseSensitive - valore booleano che indica se il controllo deve essere con distinzione tra maiuscole e minuscole o meno. Restituisce: Elenco di stringhe che indicano i nomi file che iniziano con il prefisso specificato.

ottieniOggetto (file)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Recupera un oggetto (file) dal volume del catalogo Unity e lo archivia nel percorso locale specificato. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. objectPath - il percorso dell'oggetto (file) a partire dal volume, come directory radice. localPath : percorso locale in cui archiviare i dati recuperati. Restituisce: Valore booleano che indica lo stato dell'operazione GET .

getObject (flusso)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Recupera un oggetto come flusso di input dal volume del catalogo Unity. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. objectPath - il percorso dell'oggetto (file) a partire dal volume, come directory radice. Restituisce: Istanza dell'entità di flusso di input.

putObject (file)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Carica i dati da un percorso locale a un percorso specificato all'interno di un volume di Unity Catalog. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. objectPath percorso di destinazione dal volume, considerato come directory principale, in cui caricare l'oggetto (file). localPath percorso locale da cui caricare i dati. toOverwrite valore booleano che indica se sovrascrivere l'oggetto se esiste già. Restituisce: Valore booleano che indica lo stato dell'operazione PUT.

putObject (flusso)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Carica i dati da un flusso di input in un percorso specificato all'interno di un volume di Unity Catalog. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. objectPath : percorso di destinazione in cui l'oggetto (file) deve essere caricato dal volume come directory radice. inputStream : flusso di input da cui caricare i dati. contentLength - lunghezza del flusso di input. toOverwrite valore booleano che indica se sovrascrivere l'oggetto se esiste già. Restituisce: Valore booleano che indica lo stato dell'operazione PUT.

eliminaOggetto

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Rimuove un oggetto da un percorso specificato all'interno di un volume del catalogo Unity. Parametri: catalog : nome del catalogo dell'archiviazione cloud. schema : nome dello schema dell'archiviazione cloud. volume : nome del volume UC dell'archiviazione cloud. objectPath - il percorso dell'oggetto (file) dal volume alla directory radice da cancellare. Restituisce: Valore booleano che indica lo stato dell'operazione DELETE.

Interfaccia IDatabricksGeospatial

Descrive i metodi da utilizzare con i tipi di dati geospaziali (GEOMETRY e GEOGRAPHY). Questa interfaccia è estesa dalle interfacce marcatore IGeometry e IGeography per oggetti geospaziali specifici del tipo.

Pacchetto: com.databricks.jdbc.api

getWKT
String getWKT() Restituisce la rappresentazione WKT (Well-Known Text) dell'oggetto geospaziale. Restituisce: Stringa contenente la rappresentazione WKT senza prefisso SRID.

getWKB
byte[] getWKB() Restituisce la rappresentazione Well-Known Binary (WKB) conforme a OGC dell'oggetto geospaziale. Restituisce: Matrice di byte contenente i dati WKB.

getSRID
int getSRID() Restituisce l'identificatore SRID (Spatial Reference System Identifier) dell'oggetto geospaziale. Restituisce: Intero che rappresenta il valore SRID (0 se non specificato).

ottieniTipo
String getType() Restituisce il nome del tipo geospaziale. Restituisce: Una stringa che è GEOMETRY o GEOGRAPHY.

Enumerazione ExecutionState

Contiene gli stati di una query asincrona in esecuzione.

Pacchetto: com.databricks.jdbc.api

RUNNING	L'istruzione è in esecuzione nel server
PENDING	L'istruzione deve ancora essere eseguita sul server
SUCCEEDED	La dichiarazione è stata eseguita con successo
FAILED	L'esecuzione dell'istruzione non è riuscita
ABORTED	La dichiarazione è stata interrotta
CLOSED	La dichiarazione è stata chiusa

Interfaccia IExecutionStatus

Descrizione dei metodi per recuperare lo stato di una query asincrona.

Pacchetto: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Restituisce lo stato dello stato di esecuzione. Restituisce: ExecutionState che rappresenta lo stato di esecuzione

getSqlState
String getSqlState() throws SQLException Se è impostato, restituisce il codice SQLState per uno stato di errore. Restituisce: Stringa che rappresenta il codice SQLState

getErrorMessage
String getErrorMessage() throws SQLException Restituisce il messaggio di errore di un'esecuzione non riuscita. Restituisce: Una stringa che rappresenta il messaggio di errore.