Databricks JDBC-illesztőprogramhoz készült Java API-referencia

Ez a cikk a Databricks JDBC Driver 3- és újabb verziójának API-referenciadokumentációját tartalmazza.

IDatabricksConnection felület

A kapcsolat- és utasításvégrehajtási fogantyúk lekérdezésének módszereit ismerteti.

Csomag: com.databricks.jdbc.api

getNyilatkozat
IDatabricksStatement getStatement(String statementId) throws SQLException Egy adott utasításazonosítóhoz tartozó kezelőt adja vissza. Visszatérítések Egy IDatabricksStatement egy meglévő végrehajtás kezelésére.

getConnectionId
String getConnectionId() throws SQLException Egy hivatkozást ad vissza a munkamenet-kapcsolathoz. Visszatérítések Egy sztring, amely a végrehajtás alapjául szolgáló munkamenet kapcsolatát jelöli.

IDatabricksDriver interfész

Az illesztőprogram-kapcsolat kezelésére szolgáló módszereket ismerteti.

Csomag: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver kiterjeszti com.databricks.client.jdbc.IDatabricksDriver és java.sql.Driver.

kapcsolat lezárása
void closeConnection(String url, Properties info, String connectionId) throws SQLException Bezárja a kapcsolatot az adott kapcsolatazonosítóhoz és a JDBC-kapcsolat URL-címéhez. Visszatérítések Egyik sem

IDatabricksResultSet felület

Az aszinkron lekérdezés eredményeinek lekérésére szolgáló módszereket ismerteti.

Csomag: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException A végrehajtás állapotát adja vissza. Visszatérítések A végrehajtás állapotát képviselő IExecutionStatus

getStatementId
String getStatementId() throws SQLException Az aszinkron végrehajtás társított utasításazonosítóját adja vissza. Visszatérítések A sztring, amely a végrehajtás utasításazonosítóját tartalmazza

IDatabricksStatement felület

Az aszinkron lekérdezések végrehajtásának és kezelésének módszereit ismerteti.

Csomag: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Sql-parancsot hajt végre aszinkron módban. Paraméterek: sql - a végrehajtandó parancs. Visszatérítések A végrehajtott SQL eredményeit képviselő ResultSet

getExecutionResult
ResultSet getExecutionResult() throws SQLException Egy már végrehajtott SQL-parancs állapotát és válaszát kéri le, és hibát jelez, ha nem hajtottak végre parancsot. Ezt a metódust többször is meghívhatja a lekérdezés végrehajtási állapotának lekérdezéséhez. Visszatérítések A végrehajtott SQL eredményeit képviselő ResultSet

IDatabricksVolumeClient felület

A Unity Catalog-kötetek fájljainak kezelésére szolgáló módszereket ismerteti.

Csomag: com.databricks.jdbc.api

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Meghatározza, hogy létezik-e egy adott prefix (mappaszerű struktúra) a Unity Catalog kötetben. A prefix része kell, hogy legyen a fájlnévnek. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőalapú tároló Unity Catalog kötetcíme. prefix - a létezés ellenőrzéséhez használt előtag, valamint a kötetből kiinduló relatív útvonal mint gyökérkönyvtár. caseSensitive - hogy az ellenőrzésnek kis- és nagybetű-érzékenynek kell-e lennie vagy sem. Visszatérítések Egy logikai érték, amely jelzi, hogy a prefixum létezik-e vagy sem.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Meghatározza, hogy egy adott objektum (fájl) létezik-e az Unity Catalog tárolóban. Az objektumnak pontosan meg kell egyeznie a fájlnévvel. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőalapú tároló Unity Catalog kötetcíme. objectPath - az objektum (fájl) útvonala a kötetből mint gyökérkönyvtárból kiindulva annak érdekében, hogy ellenőrizzék a létezését a kötetben (bármelyik almappában). caseSensitive - egy logikai érték, amely jelzi, hogy az ellenőrzés kis- és nagybetű-érzékeny legyen-e vagy sem. Visszatérítések Egy logikai érték, amely jelzi, hogy az objektum létezik-e vagy sem.

kötet létezik

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Meghatározza, hogy egy adott kötet létezik-e a megadott katalógusban és sémában. A hangerőnek pontosan meg kell egyeznie a hangerő nevével. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volumeName - a kötet neve, amelynek létezését ellenőrizni kell. caseSensitive egy logikai érték, amely jelzi, hogy az ellenőrzés kis- és nagybetű-érzékeny legyen-e vagy sem. Visszatérítések Egy logikai érték, amely jelzi, hogy a kötet létezik-e vagy sem.

objektumok_listázása

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Visszaadja az összes fájlnevet az Unity Catalog kötetben, amelyek egy megadott előtaggal kezdődnek. A prefixnek a kötet gyökereként a fájlútvonal részét kell képeznie. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. prefix - a listázandó fájlnevek előtagja. Ide tartozik a kötet relatív elérési útja gyökérkönyvtárként. caseSensitive - egy logikai érték, amely jelzi, hogy az ellenőrzés kis- és nagybetű-érzékeny legyen-e vagy sem. Visszatérítések A megadott előtaggal kezdődő fájlneveket jelző sztringek listája.

getObject (fájl)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Lekér egy objektumot (fájlt) a Unity Catalog tárolóból, és elmenti a megadott helyi elérési útra. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. objectPath - az objektum (fájl) útvonala a kötetből kiindulva, mint gyökérkönyvtár. localPath - az a helyi elérési útvonal, ahol a lekért adatokat tárolni kell. Visszatérítések Egy logikai érték, amely a GET művelet állapotát jelzi.

getObject (adatfolyam)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Beolvas egy objektumot bemeneti adatfolyamként a Unity Katalógus kötetéből. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. objectPath - az objektum (fájl) útvonala a kötetből kiindulva, mint gyökérkönyvtár. Visszatérítések A bemeneti stream entitás egy példánya.

putObject (fájl)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Adatok feltöltése egy helyi útvonalról egy megadott útvonalra a Unity Catalog kötetén belül. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. objectPath a célútvonal, ahol az objektum (fájl) a gyökérkönyvtárként a kötetből feltöltésre kerül. localPath a helyi elérési út, ahonnan az adatokat fel kell tölteni. toOverwrite egy logikai érték, amely jelzi, hogy felül kell-e írni az objektumot, ha már létezik. Visszatérítések Logikai érték, amely a PUT művelet állapotát jelzi.

putObject (adatfolyam)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Adatokat tölt fel egy bemeneti adatfolyamból a Unity Catalog kötet egy meghatározott útvonalára. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. objectPath - a célútvonal, ahová az objektum (fájl) a kötet gyökérkönyvtárából lesz feltöltve. inputStream - a bemeneti adatfolyam, ahonnan az adatokat fel kell tölteni. contentLength - a bemeneti adatfolyam hossza. toOverwrite egy logikai érték, amely jelzi, hogy felül kell-e írni az objektumot, ha már létezik. Visszatérítések Egy logikai érték, amely jelzi a PUT művelet állapotát.

objektumtörlés

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Eltávolít egy objektumot egy megadott elérési útból a Unity Catalog kötetben. Paraméterek: catalog - a felhőtárhely katalógus neve. schema - a felhőtárhely sémaneve. volume - a felhőtárhely UC kötet neve. objectPath - az objektum (fájl) útvonala a kötetből, mint gyökérkönyvtárból történő törléshez. Visszatérítések A DELETE művelet állapotát jelző logikai érték.

IDatabricksGeospatial interfész

A térinformatikai adattípusok (GEOMETRIA és FÖLDRAJZI HELY) használatát ismerteti. Az interfész típus-specifikus térinformatikai objektumokhoz történő bővítésére a IGeometry és IGeography jelölőillesztőket alkalmazzák.

Csomag: com.databricks.jdbc.api

getWKT
String getWKT() A térinformatikai objektum Well-Known szöveges (WKT) ábrázolását adja vissza. Visszatérítések SRID-előtag nélküli WKT-ábrázolást tartalmazó sztring.

getWKB
byte[] getWKB() A térinformatikai objektum OGC-kompatibilis Well-Known bináris (WKB) ábrázolását adja vissza. Visszatérítések A WKB-adatokat tartalmazó bájttömb.

getSRID
int getSRID() A térinformatikai objektum térinformatikai rendszerazonosítóját (SRID) adja vissza. Visszatérítések Az SRID-értéket jelölő egész szám (ha nincs megadva 0).

getType
String getType() A térinformatikai típus nevét adja vissza. Visszatérítések Egy sztring, amely vagy GEOMETRY vagy GEOGRAPHY.

VégrehajtásiÁllapot enum

Egy aszinkron lekérdezés végrehajtásának állapotát tartalmazza.

Csomag: com.databricks.jdbc.api

RUNNING	Az utasítás fut a kiszolgálón
PENDING	Az utasítás még nem fut a kiszolgálón
SUCCEEDED	A parancs sikeresen lefutott
FAILED	Az utasítás végrehajtása meghiúsult
ABORTED	A nyilatkozat megszakadt
CLOSED	A nyilatkozat le van zárva

IExecutionStatus felület

Az aszinkron lekérdezés állapotának lekérésére szolgáló módszereket ismerteti.

Csomag: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException A végrehajtási állapot állapotát adja vissza. Visszatérítések A végrehajtási állapot állapotát képviselő ExecutionState

getSqlState
String getSqlState() throws SQLException Ha be van állítva, a sikertelen állapot SQLState-kódját adja vissza. Visszatérítések Az SQLState-kódnak számító sztring

hibaüzenetLekérése
String getErrorMessage() throws SQLException Egy sikertelen végrehajtás hibaüzenetét adja vissza. Visszatérítések Egy hibaüzenetet tartalmazó sztring.