Справочник по API Java для драйвера JDBC Databricks

В этой статье приведена справочная документация по API для драйвера JDBC Databricks версии 3 и выше.

Интерфейс IDatabricksConnection

Описывает методы получения дескрипторов подключений и выполнения команд.

Пакет: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Возвращает дескриптор для заданного идентификатора запроса. Возвращает: IDatabricksStatement для обработки существующего выполнения.

получитьИдентификаторСоединения
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 Закрывает подключение для указанного идентификатора подключения и URL-адреса подключения JDBC. Возвращает: Отсутствует

Интерфейс IDatabricksResultSet

Описывает методы для получения результатов асинхронного запроса.

Пакет: com.databricks.jdbc.api

getExecutionStatus (получитьСтатусВыполнения)
IExecutionStatus getExecutionStatus() throws SQLException Возвращает состояние выполнения. Возвращает: IExecutionStatus, представляющий состояние выполнения

getStatementId
String getStatementId() throws SQLException Возвращает связанный идентификатор инструкции асинхронного выполнения. Возвращает: Строка, которая является идентификатором оператора выполнения

Интерфейс IDatabricksStatement

Описывает методы для выполнения и обработки асинхронного запроса.

Пакет: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Выполняет команду SQL в асинхронном режиме. Параметры: sql — команда для выполнения. Возвращает: Результирующий набор, представляющий результаты выполняемого SQL

getExecutionResult
ResultSet getExecutionResult() throws SQLException Извлекает состояние и ответ для уже выполненной команды SQL и выдает ошибку, если команда не была выполнена. Этот метод можно вызывать несколько раз для опроса состояния выполнения. Возвращает: Результирующий набор, представляющий результаты выполняемого SQL

Интерфейс IDatabricksVolumeClient

Описывает методы управления файлами в томах каталога Unity.

Пакет: com.databricks.jdbc.api

префиксСуществует

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Определяет, существует ли определённый префикс (папкоподобная структура) в объёме каталога Unity. Префикс должен быть частью имени файла. Параметры: catalog - название каталога облачного хранилища. schema - имя схемы облачного хранилища. volume — имя тома Unity Catalog в облачном хранилище. prefix - префикс для проверки существования вместе с относительным путем от тома в качестве корневого каталога. caseSensitive - учитывать ли регистр при проверке или нет. Возвращает: Булево значение, указывающее, существует ли префикс или нет.

objectExists

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 - название каталога облачного хранилища. schema - имя схемы облачного хранилища. volume - имя тома UC облачного хранилища. prefix - префикс имён файлов для перечисления. Это включает относительный путь от тома, рассматриваемого как корневая директория. caseSensitive - логическое значение, указывающее, должна ли проверка учитывать регистр или нет. Возвращает: Перечень строк, указывающих на имена файлов, которые начинаются с указанного префикса.

getObject(файл)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Извлекает объект (файл) из тома каталога Unity и сохраняет его в указанном локальном пути. Параметры: catalog - название каталога облачного хранилища. schema - имя схемы облачного хранилища. volume - имя тома UC облачного хранилища. objectPath - путь объекта (файла) от тома в качестве корневого каталога. localPath - локальный путь, где будут храниться полученные данные. Возвращает: Логическое значение, указывающее статус операции GET.

getObject (stream)

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.

удалитьОбъект

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Удаляет объект из указанного пути в томе каталога Unity. Параметры: catalog - название каталога облачного хранилища. schema - имя схемы облачного хранилища. volume - имя тома UC облачного хранилища. objectPath - путь объекта (файла) от корня тома до удаления. Возвращает: Логическое значение, указывающее состояние операции удаления.

Интерфейс IDatabricksGeospatial

Описывает методы для работы с геопространственных типов данных (GEOMETRY и GEOGRAPHY). Этот интерфейс расширяется интерфейсами-маркерами IGeometry и IGeography для типо-специфичных геопространственных объектов.

Пакет: com.databricks.jdbc.api

getWKT
String getWKT() Возвращает представление в формате Well-Known Text (WKT) для геопространственного объекта. Возвращает: Строка, содержащая представление WKT без префикса SRID.

getWKB
byte[] getWKB() Возвращает совместимое с OGC представление геопространственного объекта в формате Well-Known Binary (WKB). Возвращает: Массив байтов, содержащий данные WKB.

getSRID
int getSRID() Возвращает идентификатор системы пространственной ссылки (SRID) геопространственного объекта. Возвращает: Целое число, представляющее значение SRID (0, если оно не указано).

getType
String getType() Возвращает имя геопространственного типа. Возвращает: Строка, которая имеет значение GEOMETRY или GEOGRAPHY.

Перечисление СостояниеВыполнения

Содержит состояния выполнения асинхронного запроса.

Пакет: com.databricks.jdbc.api

RUNNING	Инструкция выполняется на сервере
PENDING	Утверждение еще не выполнено на сервере
SUCCEEDED	Инструкция успешно запущена
FAILED	Сбой выполнения инструкции
ABORTED	Заявление было прервано
CLOSED	Заявление закрыто

Интерфейс IExecutionStatus

Описывает методы для получения состояния асинхронного запроса.

Пакет: com.databricks.jdbc.api

ПолучитьСостояниеВыполнения
ExecutionState getExecutionState() throws SQLException Возвращает состояние статуса выполнения. Возвращает: Значение ExecutionState, представляющее состояние выполнения

getSqlState
String getSqlState() throws SQLException Если он задан, возвращает код SQLState для состояния сбоя. Возвращает: Строка, которая является кодом SQLState

getErrorMessage
String getErrorMessage() throws SQLException Возвращает сообщение об ошибке неудачного выполнения. Возвращает: Строка, которая является сообщением об ошибке.