共用方式為

Databricks JDBC 驅動程式的 Java API 參考

本文提供 Databricks JDBC 驅動程式第 3 版和更新版本的 API 參考檔。

IDatabricksConnection 介面

描述取得連接和執行語句句柄的方法。

封裝： com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException
傳回指定語句 ID 的控制代碼。
退貨
用來處理現有執行的 IDatabricksStatement 。
取得連接ID
String getConnectionId() throws SQLException
傳回會話連接的句柄。
退貨
字串，用於表示執行基礎會話的連接。

IDatabricksDriver 介面

描述管理驅動程序連線的方法。

封裝： com.databricks.client.jdbc

com.databricks.client.jdbc.Driver擴充com.databricks.client.jdbc.IDatabricksDriver和java.sql.Driver。

關閉連接
void closeConnection(String url, Properties info, String connectionId) throws SQLException
關閉指定之連接 ID 和 JDBC 連線 URL 的連線。
退貨
沒有

IDatabricksResultSet 介面

描述擷取異步查詢結果的方法。

封裝： com.databricks.jdbc.api

執行狀態獲取
IExecutionStatus getExecutionStatus() throws SQLException
傳回執行的狀態。
退貨
代表執行狀態的 IExecutionStatus
取得陳述式ID
String getStatementId() throws SQLException
傳回與異步執行相關的語句 ID。
退貨
一個表示執行語句的字串標識符

IDatabricksStatement 介面

描述執行及處理異步查詢的方法。

封裝： com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException
以異步模式執行 SQL 命令。
參數：
  • sql - 要執行的命令。

退貨
代表執行之 SQL 結果的 ResultSet
執行結果取得
ResultSet getExecutionResult() throws SQLException
擷取已執行 SQL 命令的狀態和回應，如果尚未執行任何命令，則會擲回錯誤。 此方法可以重複呼叫以查詢執行狀態。
退貨
代表執行之 SQL 結果的 ResultSet

IDatabricksVolumeClient 介面

描述管理 Unity 目錄磁碟區中檔案的方法。

封裝： com.databricks.jdbc.api

前綴存在
boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
確定特定前綴（類似於資料夾結構）是否存在於 Unity Catalog 卷中。 檔名前綴必須是檔名的一部分。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 Unity 目錄磁碟區名稱。
  • prefix - 檢查其存在的前綴，連同從磁碟卷開始的相對路徑，將其視作根目錄。
  • caseSensitive - 如何檢查是否區分大小寫。

退貨
一個布林值指出前綴是否存在。
objectExists
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException
確定特定對象（檔案）是否存在於 Unity Catalog 的資料庫中。 對象必須與檔案名稱完全匹配。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 Unity 目錄磁碟區名稱。
  • objectPath - 物件（檔案）從磁碟區視為根目錄的路徑，以檢查是否存在於該磁碟區內（在任何子資料夾中）。
  • caseSensitive - 一個布林值，表示檢查是否應區分大小寫。

退貨
用於表示物件是否存在的布林值。
volumeExists
boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException
確定特定的卷是否存在於給定的目錄和架構中。 磁碟區必須與磁碟區名稱完全匹配。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volumeName - 要檢查其存在的卷名稱。
  • caseSensitive 一個布林值，表示檢查是否應區分大小寫。

退貨
一個布林值指示音量是否存在。
列出物件
List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException
返回 Unity Catalog 卷中所有以指定前綴開始的文件名列表。 前綴必須是以卷宗作為根目錄的檔案路徑的一部分。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • prefix - 要列出的檔案名稱的前綴。 這包括從磁碟區作為根目錄的相對路徑。
  • caseSensitive - 一個布林值，表示檢查是否應區分大小寫。

退貨
說明檔案名稱以指定前綴開頭的字串列表。
getObject（檔案）
boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException
從 Unity Catalog 卷中檢索物件（文件），並將其存儲在指定的本地路徑中。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • objectPath - 從磁碟區開始作為根目錄對象（檔案）的路徑。
  • localPath - 要儲存所擷取數據的本機路徑。

退貨
布林值指示GET作業的狀態。
getObject（stream）
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException
從 Unity Catalog 卷中以輸入流的形式檢索對象。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • objectPath - 從磁碟區開始作為根目錄對象（檔案）的路徑。

退貨
輸入流實體的實例。
putObject(file)
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException
將數據從本機路徑上傳至 Unity 目錄磁碟區內的指定路徑。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • objectPath 要從 『volume 上傳物件 （file） 作為根目錄的目的地路徑。
  • localPath 要上傳數據的本機路徑。
  • toOverwrite 一個布林值，指示是否在該物件已存在的情況下覆蓋該物件。

退貨
布爾值，表示 PUT 作業的狀態。
putObject（stream）
boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException
將數據從輸入流上傳到 Unity Catalog 磁碟區中的指定路徑。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • objectPath - 將文件從卷中作為根目錄上傳至目的地路徑的位置。
  • inputStream - 用於上傳資料的輸入流。
  • contentLength - 輸入流的長度。
  • toOverwrite 一個布林值，指示是否在該物件已存在的情況下覆蓋該物件。

退貨
布林值，指示 PUT 操作的狀態。
刪除對象
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException
從 Unity Catalog 磁碟區中的指定路徑移除一個物件。
參數：
  • catalog - 雲端儲存的目錄名稱。
  • schema - 雲端存儲的結構名稱。
  • volume - 雲端記憶體的 UC 磁碟區名稱。
  • objectPath - 從磁碟中作為根目錄的物件（檔案）路徑以進行刪除。

退貨
布林值，表示 DELETE 操作的狀態。

IDatabricks地理空間介面

描述處理地理空間資料類型（GEOMETRY 與 GEOGRAPHY）的方法。 此介面透過IGeometryIGeography標記介面進行擴充，以用於特定類型的地理空間物件。

封裝： com.databricks.jdbc.api

getWKT
String getWKT()
回傳地理空間物件的 Well-Known 文字（WKT）表示。
退貨
包含 WKT 表示且不含 SRID 前綴的字串。
getWKB
byte[] getWKB()
回傳符合 OGC 標準的 Well-Known 二進位（WKB）地理空間物件表示法。
退貨
一個包含 WKB 資料的位元組陣列。
getSRID
int getSRID()
回傳地理空間物件的空間參考系統識別碼（SRID）。
退貨
一個整數代表 SRID 值（若未指定則為 0）。
getType
String getType()
回傳地理空間類型名稱。
退貨
一個字串，要麼是GEOMETRY，要麼是GEOGRAPHY。

ExecutionState 列舉

包含執行異步查詢的狀態。

封裝： com.databricks.jdbc.api

RUNNING 敘述正在伺服器上執行
PENDING 語句尚未在伺服器上執行
SUCCEEDED 陳述已成功執行
FAILED 指令執行失敗
ABORTED 聲明已中止
CLOSED 聲明已被關閉

IExecutionStatus 介面

描述擷取異步查詢狀態的方法。

封裝： com.databricks.jdbc.api

取得執行狀態
ExecutionState getExecutionState() throws SQLException
傳回執行狀態的狀態。
退貨
代表執行狀態狀態的ExecutionState
getSqlState
String getSqlState() throws SQLException
如果已設定，則會傳回失敗狀態的 SQLState 程式代碼。
退貨
字串，這是 SQLState 程式代碼
取得錯誤訊息
String getErrorMessage() throws SQLException
傳回失敗執行的錯誤訊息。
退貨
錯誤訊息的字串。
  • Last updated on