Referenční informace k rozhraní Java API pro ovladač Databricks JDBC

Tento článek obsahuje referenční dokumentaci k rozhraní API pro ovladač Databricks JDBC verze 3 a vyšší.

IDatabricksConnection – rozhraní

Popisuje metody pro načtení popisovačů připojení a provádění příkazů.

Balíček: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Vrátí popisovač pro zadané ID příkazu. Návraty: IDatabricksStatement k řízení existujícího spuštění.

getConnectionId
String getConnectionId() throws SQLException Vrátí popisovač relace připojení. Návraty: Řetězec, který představuje připojení pro podkladovou relaci spuštění.

IDatabricksDriver – rozhraní

Popisuje metody správy připojení ovladače.

Balíček: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver rozšiřuje com.databricks.client.jdbc.IDatabricksDriver a java.sql.Driver.

uzavřítSpojení
void closeConnection(String url, Properties info, String connectionId) throws SQLException Ukončí připojení pro zadané ID připojení a adresu URL připojení JDBC. Návraty: Žádné

IDatabricksResultSet – rozhraní

Popisuje metody pro načtení výsledků asynchronního dotazu.

Balíček: com.databricks.jdbc.api

ZískatStavProvádění
IExecutionStatus getExecutionStatus() throws SQLException Vrátí stav spuštění. Návraty: IExecutionStatus, který představuje stav spuštění

getIdProhlášení
String getStatementId() throws SQLException Vrátí přidružené ID příkazu asynchronního spuštění. Návraty: Řetězec, který je ID příkazu spuštění

IDatabricksStatement – rozhraní

Popisuje metody pro spuštění a zpracování asynchronního dotazu.

Balíček: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Spustí příkaz SQL v asynchronním režimu. Parametry: sql - příkaz, který se má provést. Návraty: Sada výsledků, která představuje výsledky spuštěného SQL

getExecutionResult
ResultSet getExecutionResult() throws SQLException Načte stav a odpověď pro již spuštěný příkaz SQL a vyvolá chybu, pokud nebyl proveden žádný příkaz. Tuto metodu lze volat vícekrát, aby se zjistil stav provádění. Návraty: Sada výsledků, která představuje výsledky spuštěného SQL

IDatabricksVolumeClient – rozhraní

Popisuje metody správy souborů ve svazcích katalogu Unity.

Balíček: com.databricks.jdbc.api

prefixExistuje

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Určuje, zda v objemu Unity Catalogu existuje specifická předpona (struktura podobná složce). Předpona musí být součástí názvu souboru. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume – název svazku katalogu Unity cloudového úložiště. prefix – předpona pro ověření existence spolu s relativní cestou ze svazku jako kořenového adresáře. caseSensitive - zda má být kontrola rozlišující velká a malá písmena, nebo ne. Návraty: Boolean označující, zda předpona existuje nebo ne.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Určuje, zda v objemu Unity Catalog existuje konkrétní objekt (soubor). Objekt se musí přesně shodovat s názvem souboru. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume – název svazku katalogu Unity cloudového úložiště. objectPath - cesta k objektu (souboru) z disku jako kořenového adresáře pro ověření existence v rámci disku (uvnitř jakékoli podsložky). caseSensitive – logická hodnota označující, zda má být kontrola rozlišující malá a velká písmena. Návraty: Booleanovská hodnota označující, zda objekt existuje nebo ne.

objemExistuje

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Určuje, zda v daném katalogu a schématu existuje konkrétní svazek. Objem se musí přesně shodovat s názvem objemu. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volumeName - název svazku, který má být zkontrolován na existenci. caseSensitive boolean určující, zda by kontrola měla být rozlišující velká a malá písmena nebo ne. Návraty: Logická hodnota indikující, zda svazek existuje nebo ne.

listObjects (seznam objektů)

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Vrátí seznam všech názvů souborů ve svazku katalogu Unity, který začíná zadanou předponou. Prefix musí být součástí cesty k souboru, kde je svazek kořenovým adresářem. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. prefix - předpona názvů souborů k vypsání. To zahrnuje relativní cestu z objemu jako kořenový adresář. caseSensitive – logická hodnota označující, zda má být kontrola rozlišující malá a velká písmena. Návraty: Seznam řetězců označujících názvy souborů, které začínají určenou předponou.

getObject (soubor)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Načte objekt (soubor) z jednotky Unity Catalog a uloží jej na zadanou místní cestu. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. objectPath - cesta objektu (souboru) od svazku jako kořenového adresáře. localPath – místní cesta, kam se mají načtená data ukládat. Návraty: Logická hodnota označující stav GET operace.

getObject (stream)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Načte objekt jako vstupní datový proud ze svazku katalogu Unity. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. objectPath - cesta objektu (souboru) od svazku jako kořenového adresáře. Návraty: Instance entity datového vstupního proudu.

putObject (soubor)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Nahrává data z lokální cesty na specifikovanou cestu v rámci svazku Unity Catalog. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. objectPath cílová cesta, kam má být objekt (soubor) nahrán z objemu jako kořenový adresář. localPath místní cesta, odkud mají být data nahrána. toOverwrite logická hodnota, která označuje, zda přepsat objekt, pokud již existuje. Návraty: Hodnota boolean určující stav operace PUT.

putObject (stream)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Nahrává data z vstupního proudu na určenou cestu v rámci svazku Unity Catalog. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. objectPath - cílová cesta, kam má být objekt (soubor) nahrán z objemu jako kořenový adresář. inputStream – vstupní datový proud, ze kterého se mají data nahrát. contentLength – délka vstupního datového proudu. toOverwrite logická hodnota, která označuje, zda přepsat objekt, pokud již existuje. Návraty: Logická hodnota udávající stav operace PUT.

odstranitObjekt

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Odstraní objekt z určené cesty v rámci objemu katalogu Unity. Parametry: catalog – název katalogu cloudového úložiště. schema – název schématu cloudového úložiště. volume - název objemu UC v cloudovém úložišti. objectPath - cesta objektu (souboru) od svazku jako kořenového adresáře k odstranění. Návraty: Booleanová hodnota indikující stav operace DELETE.

IDatabricksGeospatial – rozhraní

Popisuje metody pro práci s geoprostorovými datovými typy (GEOMETRY a GEOGRAPHY). Toto rozhraní je rozšířeno značkovými rozhraními IGeometry a IGeography pro typově specifické geoprostorové objekty.

Balíček: com.databricks.jdbc.api

getWKT
String getWKT() Vrátí reprezentaci Well-Known Text (WKT) geoprostorového objektu. Návraty: Řetězec obsahující reprezentaci WKT bez předpony SRID.

getWKB
byte[] getWKB() Vrátí OGC-kompatibilní reprezentaci geospatialního objektu ve formátu Well-Known Binary (WKB). Návraty: Bajtové pole obsahující data WKB.

getSRID
int getSRID() Vrátí identifikátor prostorového referenčního systému (SRID) geoprostorového objektu. Návraty: Celé číslo představující hodnotu SRID (0, pokud není zadáno).

getType
String getType() Vrátí název geoprostorového typu. Návraty: Řetězec, který je buď GEOMETRY nebo GEOGRAPHY.

ExecutionState – výčet

Obsahuje stavy spuštěného asynchronního dotazu.

Balíček: com.databricks.jdbc.api

RUNNING	Příkaz běží na serveru.
PENDING	Příkaz ještě není spuštěný na serveru.
SUCCEEDED	Příkaz se úspěšně spustil.
FAILED	Spuštění příkazu se nezdařilo.
ABORTED	Prohlášení bylo zrušeno.
CLOSED	Prohlášení bylo ukončeno.

IExecutionStatus – rozhraní

Popisuje metody pro načtení stavu asynchronního dotazu.

Balíček: com.databricks.jdbc.api

získatStavProvádění
ExecutionState getExecutionState() throws SQLException Vrátí stav provedení. Návraty: ExecutionState, který představuje stav spuštění

getSqlState
String getSqlState() throws SQLException Pokud je nastavena, vrátí kód SQLState pro stav selhání. Návraty: Řetězec, který je kódem SQLState

getErrorMessage
String getErrorMessage() throws SQLException Vrátí chybovou zprávu o neúspěšném spuštění. Návraty: Řetězec představující chybovou zprávu.