この記事では、 Databricks JDBC Driver バージョン 3 以降の API リファレンス ドキュメントを提供します。
IDatabricksConnection インターフェイス
接続ハンドルとステートメント実行ハンドルを取得するメソッドについて説明します。
パッケージ： com.databricks.jdbc.api
| ステートメントを取得 |
|---|
IDatabricksStatement getStatement(String statementId) throws SQLException特定のステートメント ID のハンドルを返します。 戻り値: 既存の実行を処理する IDatabricksStatement 。 |
| getConnectionId |
|---|
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 を返します。 戻り値: 実行のステートメント ID である文字列 |
IDatabricksStatement インターフェイス
非同期クエリを実行して処理するメソッドについて説明します。
パッケージ： com.databricks.jdbc.api
| executeAsync |
|---|
ResultSet executeAsync(String sql) throws SQLException非同期モードで 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 SQLExceptionUnity カタログ ボリュームに特定のプレフィックス (フォルダーに似た構造) が存在するかどうかを判断します。 プレフィックスは、ファイル名の一部である必要があります。 パラメーター:
戻り値: プレフィックスが存在するかどうかを示すブール値。 |
| objectExists |
|---|
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLExceptionUnity カタログ ボリュームに特定のオブジェクト (ファイル) が存在するかどうかを判断します。 オブジェクトは、ファイル名と正確に一致する必要があります。 パラメーター:
戻り値: オブジェクトが存在するかどうかを示すブール値。 |
| volumeExists |
|---|
boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException特定のボリュームが特定のカタログとスキーマに存在するかどうかを判断します。 ボリュームはボリューム名と正確に一致している必要があります。 パラメーター:
戻り値: ボリュームが存在するかどうかを示すブール値。 |
| オブジェクトをリストする |
|---|
List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException指定したプレフィックスで始まる Unity カタログ ボリューム内のすべてのファイル名の一覧を返します。 プレフィックスは、ルートとしてボリュームからのファイル パスの一部である必要があります。 パラメーター:
戻り値: 指定したプレフィックスで始まるファイル名を示す文字列の一覧。 |
| getObject (ファイル) |
|---|
boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLExceptionUnity カタログ ボリュームからオブジェクト (ファイル) を取得し、指定したローカル パスに格納します。 パラメーター:
戻り値: GET操作の状態を示すブール値。 |
| getObject (ストリーム) |
|---|
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLExceptionUnity カタログ ボリュームから入力ストリームとしてオブジェクトを取得します。 パラメーター:
戻り値: 入力ストリーム エンティティのインスタンス。 |
| putObject (ファイル) |
|---|
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLExceptionローカル パスから Unity カタログ ボリューム内の指定されたパスにデータをアップロードします。 パラメーター:
戻り値: PUT 操作の状態を示すブール値。 |
| putObject (ストリーム) |
|---|
boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException入力ストリームから Unity カタログ ボリューム内の指定されたパスにデータをアップロードします。 パラメーター:
戻り値: PUT 操作の状態を示すブール値。 |
| 削除オブジェクト |
|---|
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLExceptionUnity カタログ ボリューム内の指定したパスからオブジェクトを削除します。 パラメーター:
戻り値: DELETE 操作の状態を示すブール値。 |
IDatabricksGeospatial インターフェイス
地理空間データ型 (GEOMETRY および GEOGRAPHY) を操作するメソッドについて説明します。 このインターフェイスは、タイプ固有の地理空間オブジェクトの IGeometry および IGeography マーカー インターフェイスによって拡張されます。
パッケージ： com.databricks.jdbc.api
| getWKT |
|---|
String getWKT()地理空間オブジェクトの Well-Known Text (WKT) 表現を返します。 戻り値: SRID プレフィックスのない WKT 表現を含む文字列。 |
| 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
| getExecutionState |
|---|
ExecutionState getExecutionState() throws SQLException実行状態の状態を返します。 戻り値: 実行状態の状態を表す ExecutionState |
| getSqlState |
|---|
String getSqlState() throws SQLException設定されている場合は、失敗した状態の SQLState コードを返します。 戻り値: SQLState コードである文字列 |
| エラーメッセージを取得する |
|---|
String getErrorMessage() throws SQLException失敗した実行のエラー メッセージを返します。 戻り値: エラー メッセージである文字列。 |