Freigeben über

Java-API-Referenz für den Databricks-Treiber

Dieser Artikel enthält API-Referenzdokumentation für den Databricks JDBC-Treiber, Version 3 und höher.

IDatabricksConnection-Schnittstelle

Beschreibt Methoden zum Abrufen von Handles für die Verbindung und die Ausführung von Anweisungen.

Paket: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException
Gibt ein Handle für eine bestimmte Anweisungs-ID zurück.
Rückgabewerte:
Ein IDatabricksStatement zum Behandeln einer vorhandenen Ausführung.
getConnectionId
String getConnectionId() throws SQLException
Gibt ein Handle für die Sitzungsverbindung zurück.
Rückgabewerte:
Eine Zeichenfolge, die die Verbindung für die zugrunde liegende Sitzung der Ausführung darstellt.

IDatabricksDriver Schnittstelle

Beschreibt Methoden zum Verwalten der Treiberverbindung.

Paket: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver erweitert com.databricks.client.jdbc.IDatabricksDriver und java.sql.Driver.

closeConnection
void closeConnection(String url, Properties info, String connectionId) throws SQLException
Schließt die Verbindung für die angegebene Verbindungs-ID und die JDBC-Verbindungs-URL.
Rückgabewerte:
Nichts

IDatabricksResultSet-Schnittstelle

Beschreibt Methoden zum Abrufen von Ergebnissen einer asynchronen Abfrage.

Paket: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException
Gibt den Status der Ausführung zurück.
Rückgabewerte:
Ein IExecutionStatus , der den Status der Ausführung darstellt
getStatementId
String getStatementId() throws SQLException
Gibt die zugeordnete Anweisungs-ID der asynchronen Ausführung zurück.
Rückgabewerte:
Eine Zeichenfolge, die die Anweisungs-ID der Ausführung ist

IDatabricksStatement Schnittstelle

Beschreibt Methoden zum Ausführen und Behandeln einer asynchronen Abfrage.

Paket: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException
Führt einen SQL-Befehl im asynchronen Modus aus.
Parameter:
  • sql - der auszuführende Befehl.

Rückgabewerte:
Ein ResultSet , das die Ergebnisse der ausgeführten SQL-Datei darstellt
getExecutionResult
ResultSet getExecutionResult() throws SQLException
Ruft einen Status und eine Antwort für einen bereits ausgeführten SQL-Befehl ab und löst Einen Fehler aus, wenn kein Befehl ausgeführt wurde. Diese Methode kann mehrmals aufgerufen werden, um den Ausführungsstatus abzufragen.
Rückgabewerte:
Ein ResultSet , das die Ergebnisse der ausgeführten SQL-Datei darstellt

IDatabricksVolumeClient-Schnittstelle

Beschreibt Methoden zum Verwalten von Dateien in Unity-Katalogvolumes.

Paket: com.databricks.jdbc.api

prefixExists
boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
Bestimmt, ob ein bestimmtes Präfix (ordnerähnliche Struktur) im Unity-Katalogvolume vorhanden ist. Das Präfix muss Teil des Dateinamens sein.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume: Der Unity Catalog-Volumename des Cloudspeichers.
  • prefix: Das Präfix, dessen Vorhandensein überprüft werden soll, zusammen mit dem relativen Pfad des Volumes als Stammverzeichnis.
  • caseSensitive: gibt an, ob bei der Überprüfung die Groß- und Kleinschreibung beachtet werden soll

Rückgabewerte:
Ein boolescher Wert, der angibt, ob das Präfix vorhanden ist oder nicht.
objectExists
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException
Bestimmt, ob ein bestimmtes Objekt (Datei) im Unity-Katalogvolume vorhanden ist. Das Objekt muss exakt mit dem Dateinamen übereinstimmen.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume: Der Unity Catalog-Volumename des Cloudspeichers.
  • objectPath - der Pfad des Objekts (Datei) vom Volume als Stammverzeichnis, um das Vorhandensein innerhalb des Volumes (innerhalb eines beliebigen Unterordners) zu überprüfen.
  • caseSensitive: Ein boolescher Wert, der angibt, ob die Groß- und Kleinschreibung beachtet werden soll.

Rückgabewerte:
Ein boolescher Wert, der angibt, ob das Objekt vorhanden ist oder nicht.
volumeExists
boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException
Bestimmt, ob ein bestimmtes Volume im angegebenen Katalog und Schema vorhanden ist. Das Volume muss exakt mit dem Volumenamen übereinstimmen.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volumeName: der Name des Volumes, dessen Vorhandensein überprüft werden soll
  • caseSensitive: ein boolescher Wert, der angibt, ob die Groß- und Kleinschreibung beachtet werden soll

Rückgabewerte:
Ein boolescher Wert, der angibt, ob das Volume vorhanden ist oder nicht.
listObjects
List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
Gibt die Liste aller Dateinamen im Unity-Katalogvolume zurück, die mit einem angegebenen Präfix beginnen. Das Präfix muss Teil des Dateipfads sein, beginnend beim Volume als Wurzel.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • prefix - das Präfix der Zu listenden Dateinamen. Dies schließt den relativen Pfad vom Volume als Stammverzeichnis ein.
  • caseSensitive: Ein boolescher Wert, der angibt, ob die Groß- und Kleinschreibung beachtet werden soll.

Rückgabewerte:
Eine Liste der Zeichenfolgen, die die Dateinamen angeben, die mit dem angegebenen Präfix beginnen.
getObject (Datei)
boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException
Ruft ein Objekt (Datei) aus dem Unity Catalog-Volume ab und speichert es im angegebenen lokalen Pfad.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • objectPath - der Pfad des Objekts (Datei) aus dem Volume als Stammverzeichnis.
  • localPath - der lokale Pfad, in dem die abgerufenen Daten gespeichert werden sollen.

Rückgabewerte:
Ein boolescher Wert, der den Status des GET Vorgangs angibt.
getObject (Stream)
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Ruft ein Objekt als Eingabedatenstrom aus dem Unity-Katalogvolume ab.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • objectPath - der Pfad des Objekts (Datei) aus dem Volume als Stammverzeichnis.

Rückgabewerte:
Eine Instanz der Eingabedatenstrom-Entität.
putObject (Datei)
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException
Lädt Daten aus einem lokalen Pfad in einen angegebenen Pfad innerhalb eines Unity-Katalogvolumes hoch.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • objectPath Der Zielpfad, in dem das Objekt (Datei) aus dem Volume als Stammverzeichnis hochgeladen werden soll.
  • localPath der lokale Pfad, von dem die Daten hochgeladen werden sollen.
  • toOverwrite ein boolescher Wert, der angibt, ob das Objekt überschrieben werden soll, wenn es bereits vorhanden ist.

Rückgabewerte:
Ein boolescher Wert, der den Status des PUT-Vorgangs angibt.
putObject (Stream)
boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException
Lädt Daten aus einem Eingabedatenstrom in einen angegebenen Pfad innerhalb eines Unity-Katalogvolumes hoch.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • objectPath - der Zielpfad, in dem das Objekt (Datei) aus dem Volume als Stammverzeichnis hochgeladen werden soll.
  • inputStream - der Eingabedatenstrom, aus dem die Daten hochgeladen werden sollen.
  • contentLength - die Länge des Eingabedatenstroms.
  • toOverwrite ein boolescher Wert, der angibt, ob das Objekt überschrieben werden soll, wenn es bereits vorhanden ist.

Rückgabewerte:
Ein boolescher Wert, der den Status des PUT-Vorgangs angibt.
Objekt löschen
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Entfernt ein Objekt aus einem angegebenen Pfad innerhalb eines Unity-Katalogvolumes.
Parameter:
  • catalog - der Katalogname des Cloudspeichers.
  • schema - der Schemaname des Cloudspeichers.
  • volume - der UC-Volumename des Cloudspeichers.
  • objectPath - der Pfad des Objekts (Datei) aus dem Volume als das zu löschende Stammverzeichnis.

Rückgabewerte:
Ein boolescher Wert, der den Status des DELETE-Vorgangs angibt.

IDatabricksGeospatial-Schnittstelle

Beschreibt Methoden zum Arbeiten mit geospatialen Datentypen (GEOMETRY und GEOGRAPHY). Diese Schnittstelle wird durch IGeometryIGeography Markierungsschnittstellen für typspezifische Geospatialobjekte erweitert.

Paket: com.databricks.jdbc.api

getWKT
String getWKT()
Gibt die Well-Known Text-Darstellung (WKT) des geospatialen Objekts zurück.
Rückgabewerte:
Eine Zeichenfolge mit der WKT-Darstellung ohne SRID-Präfix.
getWKB
byte[] getWKB()
Gibt die OGC-kompatible Well-Known Binary (WKB)-Darstellung des Geospatialobjekts zurück.
Rückgabewerte:
Ein Bytearray mit den WKB-Daten.
getSRID
int getSRID()
Gibt den Spatial Reference System Identifier (SRID) des Geospatialobjekts zurück.
Rückgabewerte:
Eine ganze Zahl, die den SRID-Wert darstellt (0, wenn nicht angegeben).
getType
String getType()
Gibt den Geospatialtypnamen zurück.
Rückgabewerte:
Eine Zeichenfolge, die entweder GEOMETRY oder GEOGRAPHY.

ExecutionState-Enumeration

Enthält die Zustände einer ausgeführten asynchronen Abfrage.

Paket: com.databricks.jdbc.api

RUNNING Die Anweisung wird auf dem Server ausgeführt
PENDING Die Anweisung muss noch auf dem Server ausgeführt werden
SUCCEEDED Die Anweisung wurde erfolgreich ausgeführt
FAILED Die Ausführung der Anweisung ist fehlgeschlagen
ABORTED Die Anweisung wurde abgebrochen
CLOSED Die Anweisung wurde abgeschlossen

IExecutionStatus-Schnittstelle

Beschreibt Methoden zum Abrufen des Status einer asynchronen Abfrage.

Paket: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException
Gibt den Status des Ausführungsstatus zurück.
Rückgabewerte:
Ein ExecutionState , der den Status des Ausführungsstatus darstellt
getSqlState
String getSqlState() throws SQLException
Wenn sie festgelegt ist, wird der SQLState-Code für einen fehlgeschlagenen Status zurückgegeben.
Rückgabewerte:
Eine Zeichenfolge, die den SQLState-Code darstellt
getErrorMessage
String getErrorMessage() throws SQLException
Gibt die Fehlermeldung einer fehlgeschlagenen Ausführung zurück.
Rückgabewerte:
Eine Zeichenfolge, die die Fehlermeldung ist.
  • Last updated on