Java API-referens för Databricks JDBC-drivrutinen

Den här artikeln innehåller API-referensdokumentation för Databricks JDBC-drivrutinen, version 3 och senare.

IDatabricksConnection-gränssnitt

Beskriver metoder för att hämta anslutnings- och instruktionskörningshandtag.

Paket: com.databricks.jdbc.api

hämtaUttalande
IDatabricksStatement getStatement(String statementId) throws SQLException Returnerar ett handtag för ett angivet instruktions-ID. Returnerar: En IDatabricksStatement för att hantera en befintlig körning.

getConnectionId
String getConnectionId() throws SQLException Returnerar ett handtag för sessionsanslutningen. Returnerar: En sträng som representerar anslutningen för den underliggande sessionen i körningen.

IDatabricksDriver-gränssnitt

Beskriver metoder för att hantera drivrutinsanslutningen.

Paket: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver utökar com.databricks.client.jdbc.IDatabricksDriver och java.sql.Driver.

stäng anslutning
void closeConnection(String url, Properties info, String connectionId) throws SQLException Stänger anslutningen för det angivna anslutnings-ID:t och JDBC-anslutnings-URL:en. Returnerar: Ingen

IDatabricksResultSet-gränssnitt

Beskriver metoder för att hämta resultat av en asynkron fråga.

Paket: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Returnerar exekveringens status. Returnerar: En IExecutionStatus som representerar exekveringens status

hämtaUttalandeId
String getStatementId() throws SQLException Returnerar det associerade instruktions-ID:t för asynkron körning. Returnerar: En sträng som är instruktions-ID för körningen

IDatabricksStatement-gränssnitt

Beskriver metoder för att köra och hantera en asynkron fråga.

Paket: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Kör ett SQL-kommando i asynkront läge. Parametrar: sql – kommandot som ska köras. Returnerar: En ResultSet som representerar resultatet av den körda SQL

getExecutionResult
ResultSet getExecutionResult() throws SQLException Hämtar status och svar för ett sql-kommando som redan har körts och genererar fel om inget kommando har körts. Den här metoden kan anropas flera gånger för att kontrollera körningsstatus. Returnerar: En ResultSet som representerar resultatet av den körda SQL

IDatabricksVolumeClient-gränssnitt

Beskriver metoder för att hantera filer i Unity Catalog-volymer.

Paket: com.databricks.jdbc.api

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Avgör om ett specifikt prefix (mapp-liknande struktur) finns i Unity Catalog-volymen. Prefixet måste vara en del av filnamnet. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - namnet på Unity Catalog-volymen för molnlagring. prefix - prefixen för att kontrollera förekomsten tillsammans med den relativa sökvägen från volymen som root-katalog. caseSensitive - om kontrollen ska vara skiftlägeskänslig eller inte. Returnerar: En boolean som indikerar om prefixet finns eller inte.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Avgör om ett specifikt objekt (fil) finns i Unity Catalog-volymen. Objektet måste exakt matcha filnamnet. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - namnet på Unity Catalog-volymen för molnlagring. objectPath - objektets (filens) väg från volymen som rotkatalog för att kontrollera existens inom volymen (inuti någon underkatalog). caseSensitive - en boolesk som anger om kontrollen ska vara versalskänslig eller inte. Returnerar: Ett booleskt värde som anger om objektet finns eller inte.

volym finns

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Avgör om en specifik volym finns i den angivna katalogen och schemat. Volymen måste exakt matcha volymnamnet. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volumeName - namnet på volymen för att kontrollera om den finns. caseSensitive en boolean som anger om kontrollen ska vara skiftlägeskänslig eller inte. Returnerar: En boolesk variabel som anger om volymen finns eller inte.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Returnerar en lista över alla filnamn i Unity Catalog-volymen som börjar med ett angivet prefix. Prefixet måste vara en del av filsökvägen från volymen som rot. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. prefix - prefixen för filnamnen att lista. Detta inkluderar den relativa sökvägen från volymen som rotkatalog. caseSensitive - en boolesk som anger om kontrollen ska vara versalskänslig eller inte. Returnerar: En lista med strängar som anger filnamnen som börjar med det angivna prefixet.

hämtaObjekt (fil)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Hämtar ett objekt (fil) från Unity Catalog-volymen och lagrar det på den angivna lokala sökvägen. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. objectPath - objektets (filens) sökväg från volymen med rotkatalogen som startpunkt. localPath - den lokala sökvägen där de hämtade data ska lagras. Returnerar: Ett booleanskt värde som anger statusen för GET operationen.

getObject (ström)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Hämtar ett objekt som en indataström från Unity-katalogens volym. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. objectPath - objektets (filens) sökväg från volymen med rotkatalogen som startpunkt. Returnerar: En instans av indataströmentiteten.

putObject (fil)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Laddar upp data från en lokal sökväg till en angiven sökväg inom en Unity Catalog-volym. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. objectPath destinationssökan där objektet (filen) ska laddas upp från volymen som rotkatalog. localPath den lokala sökvägen där data ska laddas upp. toOverwrite ett booleskt värde som anger om objektet ska skrivas över om det redan finns. Returnerar: Ett booleanvärde som indikerar statusen för PUT-arbetet.

putObject (ström)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Laddar upp data från en indataström till en angiven sökväg inom en Unity Catalog-volym. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. objectPath - målvägen där objektet (filen) ska överföras från volymen som rotkatalog. inputStream - inmatningsströmmen från vilken data ska överföras. contentLength - längden på indataströmmen. toOverwrite ett booleskt värde som anger om objektet ska skrivas över om det redan finns. Returnerar: Ett booleskt värde som anger statusen för PUT-operationen.

raderaObjekt

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Tar bort ett objekt från en angiven sökväg inom en Unity Catalog volym. Parametrar: catalog - katalognamnet för molnlagringen. schema - schemanamn för molnlagringen. volume - UC-volymnamnet för molnlagringen. objectPath - sökvägen för objektet (filen) från volymen som rotkatalog för att ta bort. Returnerar: Ett booleskt värde som anger statusen för DELETE-operationen.

IDatabricksGeospatialt gränssnitt

Beskriver metoder för att arbeta med geospatiala datatyper (GEOMETRI och GEOGRAFI). Det här gränssnittet utökas med IGeometry och IGeography markörgränssnitt för typspecifika geospatiala objekt.

Paket: com.databricks.jdbc.api

getWKT
String getWKT() Returnerar Well-Known Text-representationen (WKT) för geospatiala objektet. Returnerar: En sträng som innehåller WKT-representationen utan SRID-prefix.

getWKB
byte[] getWKB() Returnerar den OGC-kompatibla Well-Known Binary (WKB) representationen av det geospatiala objektet. Returnerar: En bytematris som innehåller WKB-data.

getSRID
int getSRID() Returnerar SRID (Spatial Reference System Identifier) för det geospatiala objektet. Returnerar: Ett heltal som representerar SRID-värdet (0 om det inte anges).

getType
String getType() Returnerar namnet på den geospatiala typen. Returnerar: En sträng som är antingen GEOMETRY eller GEOGRAPHY.

ExecutionState-uppräkning

Innehåller tillstånden för en körande asynkron fråga.

Paket: com.databricks.jdbc.api

RUNNING	Instruktionen körs på servern
PENDING	Instruktionen har ännu inte körts på servern
SUCCEEDED	Påståendet kördes framgångsrikt
FAILED	Körningen av kommandot misslyckades
ABORTED	Uttalandet avbröts
CLOSED	Uttalandet har stängts

IExecutionStatus-gränssnitt

Beskriver metoder för att hämta status för en asynkron fråga.

Paket: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Returnerar körningsstatusens tillstånd. Returnerar: En ExecutionState som representerar exekveringsstatusens tillstånd

getSqlState
String getSqlState() throws SQLException Om den anges returnerar SQLState-koden för en misslyckad status. Returnerar: En sträng som är SQLState-koden

hämtaFelmeddelande
String getErrorMessage() throws SQLException Returnerar felmeddelandet för en misslyckad körning. Returnerar: En sträng som utgör felmeddelandet.