Udostępnij przez

Dokumentacja API Java dla sterownika JDBC usługi Databricks

Ten artykuł zawiera dokumentację referencyjną interfejsu API dla sterownika JDBC usługi Databricks w wersji 3 lub nowszej.

Interfejs IDatabricksConnection

Opisuje metody pobierania uchwytów do połączeń i wykonywania instrukcji.

Pakiet: com.databricks.jdbc.api

pobierzOświadczenie
IDatabricksStatement getStatement(String statementId) throws SQLException
Zwraca uchwyt dla danego identyfikatora instrukcji.
Zwraca:
IDatabricksStatement do obsługi istniejącej realizacji.
getConnectionId
String getConnectionId() throws SQLException
Zwraca uchwyt dla połączenia sesji.
Zwraca:
Parametry reprezentujące połączenie dla podstawowej sesji wykonywania.

Interfejs IDatabricksDriver

Opisuje metody zarządzania połączeniem sterownika.

Pakiet: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver rozszerza com.databricks.client.jdbc.IDatabricksDriver i java.sql.Driver.

zamknijPołączenie
void closeConnection(String url, Properties info, String connectionId) throws SQLException
Zamyka połączenie dla podanego identyfikatora połączenia i adresu URL połączenia JDBC.
Zwraca:
Żaden

IDatabricksResultSet Interfejs

Opisuje metody pobierania wyników zapytania asynchronicznego.

Pakiet: com.databricks.jdbc.api

pobierzStatusWykonania
IExecutionStatus getExecutionStatus() throws SQLException
Zwraca stan wykonania.
Zwraca:
IExecutionStatus reprezentujący stan wykonania
pobierzIdentyfikatorDeklaracji
String getStatementId() throws SQLException
Zwraca skojarzony identyfikator instrukcji wykonania asynchronicznego.
Zwraca:
Ciąg znaków, który jest identyfikatorem instrukcji wykonywanej.

IDatabricksStatement, interfejs

Opisuje metody wykonywania i obsługi zapytania asynchronicznego.

Pakiet: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException
Wykonuje polecenie SQL w trybie asynchronicznym.
Parametry:
  • sql - polecenie do wykonania.

Zwraca:
Zestaw wyników reprezentujący wyniki wykonanego kodu SQL
PobierzWynikWykonania
ResultSet getExecutionResult() throws SQLException
Pobiera stan i odpowiedź dla już wykonanego polecenia SQL i zgłasza błąd, jeśli polecenie nie zostało wykonane. Tę metodę można wywołać wiele razy w celu sprawdzania stanu wykonania.
Zwraca:
Zestaw wyników reprezentujący wyniki wykonanego kodu SQL

interfejs IDatabricksVolumeClient

Opisuje metody zarządzania plikami w wolumenach Unity Catalog.

Pakiet: com.databricks.jdbc.api

prefiksIstnieje
boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
Ustala, czy określony prefiks (struktura przypominająca folder) istnieje w wolumenie Unity Catalog. Przedrostek musi być częścią nazwy pliku.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa wolumenu Unity Catalog w pamięci masowej w chmurze.
  • prefix - prefiks do sprawdzenia istnienia razem ze ścieżką względną od wolumenu jako katalogu głównego.
  • caseSensitive - czy sprawdzanie powinno uwzględniać wielkość liter czy nie.

Zwraca:
Wartość logiczna wskazująca, czy prefiks istnieje, czy nie.
objectExists
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException
Określa, czy konkretny obiekt (plik) istnieje w wolumenie Unity Catalog. Obiekt musi dokładnie odpowiadać nazwie pliku.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa wolumenu Unity Catalog w pamięci masowej w chmurze.
  • objectPath - ścieżka obiektu (pliku) od woluminu jako katalogu głównego, aby sprawdzić jego istnienie w obrębie woluminu (wewnątrz dowolnego podfolderu).
  • caseSensitive - wartość logiczna wskazująca, czy sprawdzanie powinno uwzględniać wielkość liter.

Zwraca:
Bool oznaczający, czy obiekt istnieje, czy nie.
woluminIstnieje
boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException
Określa, czy określony wolumin istnieje w podanym katalogu i schemacie. Wolumin musi dokładnie odpowiadać nazwie woluminu.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volumeName - nazwa wolumenu do sprawdzenia jego istnienia.
  • caseSensitive zmienna logiczna wskazująca, czy sprawdzanie ma być uwzględniane wielkość liter, czy nie.

Zwraca:
Wartość logiczna wskazująca, czy wolumin istnieje, czy nie.
listujObiekty
List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
Zwraca listę wszystkich nazw plików w woluminie Unity Catalog, które zaczynają się od określonego prefiksu. Prefiks musi być częścią ścieżki pliku z woluminu jako korzeń.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • prefix - prefiks nazw plików do wyświetlenia. Obejmuje to ścieżkę względną od woluminu jako katalogu głównego.
  • caseSensitive - wartość logiczna wskazująca, czy sprawdzanie powinno uwzględniać wielkość liter.

Zwraca:
Lista ciągów wskazujących nazwy plików, które zaczynają się od określonego prefiksu.
funkcja getObject (file)
boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException
Pobiera obiekt (plik) z woluminu Unity Catalog i zapisuje go we wskazanej lokalnej ścieżce.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • objectPath — ścieżka obiektu (pliku) z woluminu jako katalog główny.
  • localPath — ścieżka lokalna, w której mają być przechowywane pobrane dane.

Zwraca:
Wartość logiczna wskazująca stan GET operacji.
getObject (strumień)
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Pobiera obiekt jako strumień wejściowy z woluminu katalogu Unity.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • objectPath — ścieżka obiektu (pliku) z woluminu jako katalog główny.

Zwraca:
Wystąpienie obiektu strumienia wejściowego.
putObject (plik)
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException
Przesyłanie danych z lokalnej ścieżki do określonej ścieżki w obrębie wolumenu Unity Catalog.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • objectPath ścieżka docelowa, w której obiekt (plik) ma zostać przesłany z woluminu jako katalogu głównego.
  • localPath ścieżka lokalna, z której mają zostać przekazane dane.
  • toOverwrite wartość logiczna wskazująca, czy nadpisać obiekt, jeśli już istnieje.

Zwraca:
Wartość logiczna wskazująca status operacji PUT.
putObject (strumień)
boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException
Przesyła dane z przepływu wejściowego do określonej ścieżki w woluminie Unity Catalog.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • objectPath - ścieżka docelowa, do której obiekt (plik) ma być przesłany z woluminu jako katalog główny.
  • inputStream - strumień wejściowy, z którego dane mają zostać przesłane.
  • contentLength - długość strumienia wejściowego.
  • toOverwrite wartość logiczna wskazująca, czy nadpisać obiekt, jeśli już istnieje.

Zwraca:
Wartość logiczna wskazująca stan operacji PUT.
usuńObiekt
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Usuwa obiekt z określonej ścieżki w obrębie woluminu Katalogu Unity.
Parametry:
  • catalog - nazwa katalogu magazynu w chmurze.
  • schema - nazwa schematu pamięci w chmurze.
  • volume - nazwa woluminu UC w chmurze.
  • objectPath - ścieżka obiektu (pliku) od woluminu, jako katalogu głównego, do usunięcia.

Zwraca:
Wartość logiczna wskazująca status operacji USUNIĘCIA.

Interfejs IDatabricksGeospatial

Opisuje metody pracy z typami danych geoprzestrzennych (GEOMETRY i GEOGRAPHY). Ten interfejs jest rozszerzany przez IGeometry i IGeography interfejsy znaczników dla obiektów geoprzestrzennych specyficznych dla typu.

Pakiet: com.databricks.jdbc.api

getWKT
String getWKT()
Zwraca reprezentację obiektu geoprzestrzennego Well-Known Text (WKT).
Zwraca:
Ciąg zawierający reprezentację WKT bez prefiksu SRID.
getWKB
byte[] getWKB()
Zwraca zgodną z OGC binarną reprezentację dobrze znaną (WKB) obiektu geoprzestrzennego.
Zwraca:
Tablica bajtów zawierająca dane WKB.
getSRID
int getSRID()
Zwraca identyfikator systemu referencyjnego przestrzennego (SRID) obiektu geoprzestrzennego.
Zwraca:
Liczba całkowita reprezentująca wartość SRID (0, jeśli nie została określona).
pobierzTyp
String getType()
Zwraca nazwę typu geoprzestrzennego.
Zwraca:
Ciąg, który jest albo GEOMETRY albo GEOGRAPHY.

Enum ExecutionState

Zawiera stany wykonywanego zapytania asynchronicznego.

Pakiet: com.databricks.jdbc.api

RUNNING Instrukcja jest uruchomiona na serwerze
PENDING Oświadczenie nie zostało jeszcze wykonane na serwerze
SUCCEEDED Polecenie zostało pomyślnie wykonane
FAILED Wykonanie instrukcji nie powiodło się
ABORTED Oświadczenie zostało przerwane
CLOSED Oświadczenie zostało zamknięte

Interfejs IExecutionStatus

Opisuje metody pobierania stanu zapytania asynchronicznego.

Pakiet: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException
Zwraca stan stanu wykonania.
Zwraca:
Stan wykonania, który reprezentuje stan wykonania
getSqlState
String getSqlState() throws SQLException
Jeśli jest ustawiona, zwraca kod SQLState dla stanu niepowodzenia.
Zwraca:
Ciąg, który jest kodem SQLState
getErrorMessage
String getErrorMessage() throws SQLException
Zwraca komunikat o błędzie wykonania, który zakończył się niepowodzeniem.
Zwraca:
Ciąg znaków będący komunikatem o błędzie.
  • Last updated on