Databricks JDBC ドライバー (OSS) の Java API リファレンス

この記事では、 Databricks JDBC ドライバー (OSS) の API リファレンス ドキュメントを提供します。

IDatabricksConnection インターフェイス

接続ハンドルと文実行ハンドルを取得する方法について説明します。

パッケージ： com.databricks.jdbc.api

getStatement
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

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException 実行のステータスを返します。 収益： 実行の状態を表す IExecutionStatus

getStatementId
String getStatementId() throws SQLException 非同期実行の関連づけられた statement-id を返します。 収益： 実行のステートメント ID である文字列

IDatabricksStatement インターフェイス

非同期クエリを実行および処理するメソッドについて説明します。

パッケージ： com.databricks.jdbc.api

executeAsync の
ResultSet executeAsync(String sql) throws SQLException SQL コマンドを非同期モードで実行します。 パラメーター: sql - 実行するコマンド。 収益： 実行された SQL の結果を表す ResultSet

getExecutionResult
ResultSet getExecutionResult() throws SQLException 既に実行されている SQL コマンドの状態と応答をフェッチし、コマンドが実行されていない場合はエラーをスローします。 このメソッドを複数回呼び出して、実行ステータスをポーリングできます。 収益： 実行された SQL の結果を表す ResultSet

IDatabricksVolumeClient インターフェイス

Unity Catalog ボリューム内のファイルを管理する方法について説明します。

パッケージ： com.databricks.jdbc.api

プレフィックスが存在する

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException 特定のプレフィックス (フォルダーのような構造) が Unity Catalog ボリュームに存在するかどうかを判断します。プレフィックスは、ファイル名の一部である必要があります。 パラメーター: catalog - クラウドストレージのカタログ名。 schema - クラウドストレージのスキーマ名。 volume - クラウドストレージの Unity Catalog ボリューム名。 prefix - 存在を確認するプレフィックスと、ルートディレクトリとしてのボリュームからの相対パス。 caseSensitive - チェックで大文字と小文字を区別するかどうか。 収益： プレフィックスが存在するかどうかを示すブール値。

オブジェクトが存在する

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException 特定のオブジェクト (ファイル) が Unity Catalog ボリュームに存在するかどうかを判断します。オブジェクトはファイル名と完全に一致する必要があります。 パラメーター: catalog - クラウドストレージのカタログ名。 schema - クラウドストレージのスキーマ名。 volume - クラウドストレージの Unity Catalog ボリューム名。 objectPath - ボリューム内(任意のサブフォルダ内)に存在するかどうかを確認するためのルートディレクトリとしてのボリュームからのオブジェクト(ファイル)のパス。 caseSensitive - チェックで大文字と小文字を区別するかどうかを示すブール値。 収益： オブジェクトが存在するかどうかを示すブール値。

ボリュームが存在する
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 (ストリーム)
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Unity Catalog ボリュームからオブジェクトを入力ストリームとして取得します。 パラメーター: catalog - クラウドストレージのカタログ名。 schema - クラウドストレージのスキーマ名。 volume - クラウドストレージのUCボリューム名。 objectPath - ボリュームからのオブジェクト(ファイル)のパスをルートディレクトリとして。 収益： 入力ストリームエンティティのインスタンス。

putObject (ファイル)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException ローカル パスから Unity Catalog ボリューム内の指定したパスにデータをアップロードします。 パラメーター: catalog - クラウドストレージのカタログ名。 schema - クラウドストレージのスキーマ名。 volume - クラウドストレージのUCボリューム名。 objectPath オブジェクト(ファイル)がアップロードされる宛先パスは、ルートディレクトリとして「ボリューム」です。 localPath データのアップロード元となるローカル パス。 toOverwrite オブジェクトが既に存在する場合に上書きするかどうかを示すブール値。 収益： PUT 操作のステータスを示すブール値。

putObject (ストリーム)

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 操作のステータスを示すブール値。

deleteObjectの
boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Unity Catalog ボリューム内の指定したパスからオブジェクトを削除します。 パラメーター: catalog - クラウドストレージのカタログ名。 schema - クラウドストレージのスキーマ名。 volume - クラウドストレージのUCボリューム名。 objectPath - ボリュームからのオブジェクト (ファイル) のパスを、削除するルート ディレクトリとして指定します。 収益： DELETE 操作のステータスを示すブール値。

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 コードである文字列

getErrorMessage
String getErrorMessage() throws SQLException 失敗した実行のエラーメッセージを返します。 収益： エラー メッセージである文字列。