Referensi Java API untuk Driver Databricks JDBC

Artikel ini menyediakan dokumentasi referensi API untuk Driver JDBC Databricks, versi 3 ke atas.

Antarmuka IDatabricksConnection

Menggambarkan cara memperoleh pegangan eksekusi koneksi dan pernyataan.

Paket: com.databricks.jdbc.api

dapatkanPernyataan
IDatabricksStatement getStatement(String statementId) throws SQLException Mengembalikan handel untuk ID pernyataan tertentu. Pengembalian: IDatabricksStatement untuk menangani eksekusi yang ada.

getConnectionId
String getConnectionId() throws SQLException Mengembalikan pengidentifikasi untuk koneksi sesi. Pengembalian: String yang mewakili koneksi untuk sesi yang mendasari eksekusi.

Antarmuka IDatabricksDriver

Menjelaskan metode untuk mengelola koneksi driver.

Paket: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver memperluas com.databricks.client.jdbc.IDatabricksDriver dan java.sql.Driver.

tutupKoneksi
void closeConnection(String url, Properties info, String connectionId) throws SQLException Menutup koneksi untuk ID koneksi dan URL koneksi JDBC yang ditentukan. Pengembalian: Tidak ada

Antarmuka IDatabricksResultSet

Menjelaskan metode untuk mengambil hasil kueri asinkron.

Paket: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Mengembalikan status eksekusi. Pengembalian: IExecutionStatus yang mewakili status eksekusi

getStatementId
String getStatementId() throws SQLException Mengembalikan ID pernyataan terkait dari eksekusi asinkron. Pengembalian: String yang merupakan identitas pernyataan eksekusi

Antarmuka IDatabricksStatement

Menjelaskan metode untuk menjalankan dan menangani kueri asinkron.

Paket: com.databricks.jdbc.api

jalankanAsinkron
ResultSet executeAsync(String sql) throws SQLException Menjalankan perintah SQL dalam mode asinkron. Parameter-parameternya: sql - perintah untuk dijalankan. Pengembalian: ResultSet yang mewakili hasil SQL yang dijalankan

HasilEksekusiDiperoleh
ResultSet getExecutionResult() throws SQLException Mengambil status dan respons untuk perintah SQL yang sudah dijalankan, dan melemparkan kesalahan jika tidak ada perintah yang dijalankan. Metode ini dapat dipanggil beberapa kali untuk memeriksa status eksekusi. Pengembalian: ResultSet yang mewakili hasil SQL yang dijalankan

IDatabricksVolumeClient antarmuka

Menjelaskan metode untuk mengelola file dalam volume Katalog Unity.

Paket: com.databricks.jdbc.api

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Menentukan apakah sebuah prefix spesifik (struktur mirip folder) ada di dalam volume Unity Catalog. Awalan harus menjadi bagian dari nama file. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume Unity Catalog dari penyimpanan awan. prefix - awalan untuk memeriksa keberadaan bersama dengan jalur relatif dari volume sebagai direktori akar. caseSensitive - apakah pemeriksaan harus peka terhadap huruf besar/kecil atau tidak. Pengembalian: Boolean yang menunjukkan apakah awalan ada atau tidak.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Menentukan apakah objek tertentu (file) ada dalam volume Unity Catalog. Objek harus cocok persis dengan nama file. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume Unity Catalog dari penyimpanan awan. objectPath - jalur objek (file) dari volume sebagai direktori akar untuk memeriksa keberadaan dalam volume (di dalam sub-folder apa pun). caseSensitive - sebuah boolean yang menunjukkan apakah pemeriksaan harus peka huruf besar dan kecil atau tidak. Pengembalian: Nilai boolean yang menunjukkan apakah objek tersebut ada atau tidak.

volume ada

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Menentukan apakah volume tertentu ada dalam katalog dan skema yang diberikan. Volume harus sama persis dengan nama volume. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volumeName - nama volume untuk memeriksa apakah ada. caseSensitive boolean yang menunjukkan apakah pemeriksaan harus sensitif terhadap huruf besar/kecil atau tidak. Pengembalian: Sebuah boolean yang menunjukkan apakah volume ada atau tidak.

Daftar Objek

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Mengembalikan daftar semua nama file dalam volume Unity Catalog yang dimulai dengan awalan tertentu. Prefiks harus menjadi bagian dari jalur berkas dari volume sebagai akar. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. prefix - awalan dari nama file yang akan ditampilkan. Ini termasuk jalur relatif dari volume sebagai direktori root. caseSensitive - sebuah boolean yang menunjukkan apakah pemeriksaan harus peka huruf besar dan kecil atau tidak. Pengembalian: Daftar string yang menunjukkan nama file yang dimulai dengan awalan yang ditentukan.

mendapatkanObjek (file)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Mengambil sebuah objek (file) dari volume Unity Catalog dan menyimpannya di jalur lokal yang ditentukan. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. objectPath - jalur dari objek (file) dari volume sebagai direktori root. localPath - jalur lokal tempat data yang diambil akan disimpan. Pengembalian: Nilai boolean yang menunjukkan status operasi GET.

getObject (aliran)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Mengambil objek sebagai aliran input dari volume Unity Catalog. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. objectPath - jalur dari objek (file) dari volume sebagai direktori root. Pengembalian: Sebuah contoh entitas aliran masukan.

putObject (file)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Mengunggah data dari jalur lokal ke jalur yang ditentukan dalam volume Unity Catalog. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. objectPath jalur tujuan di mana objek (file) akan diunggah dari `volume sebagai direktori root. localPath jalur lokal dari mana data akan diunggah. toOverwrite sebuah boolean yang menunjukkan apakah akan menimpa objek jika sudah ada. Pengembalian: Sebuah nilai boolean yang menunjukkan status operasi PUT.

putObject (aliran)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Mengunggah data dari aliran input ke jalur tertentu dalam volume Katalog Unity. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. objectPath - jalur tujuan tempat objek (file) akan diunggah dari volume sebagai direktori root. inputStream - aliran data masuk dari mana data akan diunggah. contentLength - panjang aliran input. toOverwrite sebuah boolean yang menunjukkan apakah akan menimpa objek jika sudah ada. Pengembalian: Nilai boolean yang menunjukkan status operasi PUT.

deleteObject

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Menghapus sebuah objek dari jalur yang ditentukan dalam volume Unity Catalog. Parameter-parameternya: catalog - nama katalog dari penyimpanan awan. schema - nama skema penyimpanan awan. volume - nama volume UC dari penyimpanan awan. objectPath - jalur objek (file) dari volume sebagai direktori root untuk dihapus. Pengembalian: Sebuah nilai boolean yang menunjukkan status operasi DELETE.

Antarmuka IDatabricksGeospatial

Menjelaskan metode untuk bekerja dengan jenis data geospasial (GEOMETRI dan GEOGRAFI). Antarmuka ini diperluas oleh IGeometry dan IGeography antarmuka penanda untuk objek geospasial khusus jenis.

Paket: com.databricks.jdbc.api

getWKT
String getWKT() Mengembalikan representasi teks Well-Known (WKT) dari objek geospasial. Pengembalian: String yang berisi representasi WKT tanpa awalan SRID.

getWKB
byte[] getWKB() Mengembalikan representasi Well-Known Binary (WKB) sesuai standar OGC dari objek geospasial. Pengembalian: Array byte yang berisi data WKB.

getSRID
int getSRID() Mengembalikan Pengidentifikasi Sistem Referensi Spasial (SRID) dari objek geospasial. Pengembalian: Bilangan bulat yang mewakili nilai SRID (0 jika tidak ditentukan).

getType
String getType() Mengembalikan nama jenis geospasial. Pengembalian: String yang berupa GEOMETRY atau GEOGRAPHY.

Enum ExecutionState

Berisi status dari sebuah kueri asinkron yang sedang berjalan.

Paket: com.databricks.jdbc.api

RUNNING	Pernyataan berjalan di server
PENDING	Pernyataan belum berjalan di server
SUCCEEDED	Pernyataan berhasil dijalankan
FAILED	Eksekusi pernyataan gagal
ABORTED	Pernyataan dibatalkan
CLOSED	Pernyataan telah ditutup

Antarmuka IExecutionStatus

Menjelaskan metode untuk mengambil status kueri asinkron.

Paket: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Mengembalikan status eksekusi. Pengembalian: ExecutionState yang mewakili status eksekusi

getSqlState
String getSqlState() throws SQLException Jika diatur, mengembalikan kode SQLState untuk status gagal. Pengembalian: String yang merupakan kode SQLState

dapatkanPesanError
String getErrorMessage() throws SQLException Mengembalikan pesan kesalahan dari eksekusi yang gagal. Pengembalian: String yang merupakan pesan kesalahan.