다음을 통해 공유

Databricks JDBC 드라이버에 대한 Java API 참조

이 문서에서는 Databricks JDBC Driver 버전 3 이상에 대한 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

실행 상태 가져오기
IExecutionStatus getExecutionStatus() throws SQLException
실행 상태를 반환합니다.
반환 값:
실행 상태를 나타내는 IExecutionStatus
getStatementId
String getStatementId() throws SQLException
비동기 실행의 연결된 문 ID를 반환합니다.
반환 값:
실행의 문 ID인 문자열입니다.

IDatabricksStatement 인터페이스

비동기 쿼리를 실행하고 처리하는 메서드에 대해 설명합니다.

패키지: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException
비동기 모드에서 SQL 명령을 실행합니다.
매개 변수:
  • sql - 실행할 명령입니다.

반환 값:
실행된 SQL의 결과를 나타내는 ResultSet
getExecutionResult
ResultSet getExecutionResult() throws SQLException
이미 실행된 SQL 명령에 대한 상태 및 응답을 가져오고 명령이 실행되지 않은 경우 오류를 throw합니다. 이 메서드를 여러 번 호출하여 실행 상태를 폴링할 수 있습니다.
반환 값:
실행된 SQL의 결과를 나타내는 ResultSet

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 카탈로그 볼륨 이름입니다.
  • prefix - 볼륨의 상대 경로와 함께 존재 여부를 확인할 접두사를 루트 디렉터리로 지정합니다.
  • caseSensitive - 검사가 대/소문자를 구분해야 하는지 여부.

반환 값:
접두사 존재 여부를 나타내는 부울입니다.
objectExists
boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException
Unity 카탈로그 볼륨에 특정 개체(파일)가 있는지 확인합니다. 개체는 파일 이름과 정확히 일치해야 합니다.
매개 변수:
  • catalog - 클라우드 스토리지의 카탈로그 이름입니다.
  • schema - 클라우드 스토리지의 스키마 이름입니다.
  • volume - 클라우드 스토리지의 Unity 카탈로그 볼륨 이름입니다.
  • 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(스트림)
InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException
Unity 카탈로그 볼륨에서 개체를 입력 스트림으로 검색합니다.
매개 변수:
  • catalog - 클라우드 스토리지의 카탈로그 이름입니다.
  • schema - 클라우드 스토리지의 스키마 이름입니다.
  • volume - 클라우드 스토리지의 UC 볼륨 이름입니다.
  • objectPath - 볼륨에서 루트 디렉터리로 개체(파일)의 경로입니다.

반환 값:
입력 스트림 엔터티의 인스턴스입니다.
putObject(파일)
boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException
로컬 경로에서 Unity 카탈로그 볼륨 내의 지정된 경로로 데이터를 업로드합니다.
매개 변수:
  • 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 - 클라우드 스토리지의 카탈로그 이름입니다.
  • 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 - 삭제할 루트 디렉터리로 볼륨에서 개체(파일)의 경로입니다.

반환 값:
DELETE 작업의 상태를 나타내는 부울 값입니다.

IDatabricksGeospatial 인터페이스

지리 공간적 데이터 형식(GEOMETRY 및 GEOGRAPHY)을 사용하는 메서드에 대해 설명합니다. 이 인터페이스는 형식별 지리 공간적 개체에 대한 표식 인터페이스로 IGeometryIGeography 확장됩니다.

패키지: com.databricks.jdbc.api

getWKT
String getWKT()
지리 공간적 개체의 WKT(Well-Known Text) 표현을 반환합니다.
반환 값:
SRID 접두사 없이 WKT 표현을 포함하는 문자열입니다.
getWKB
byte[] getWKB()
지리 공간적 개체의 WKB(OGC 규격 Well-Known Binary) 표현을 반환합니다.
반환 값:
WKB 데이터를 포함하는 바이트 배열입니다.
getSRID
int getSRID()
지리 공간 개체의 SRID(Spatial Reference System Identifier)를 반환합니다.
반환 값:
SRID 값을 나타내는 정수입니다(지정하지 않은 경우 0).
getType
String getType()
지리 공간적 형식 이름을 반환합니다.
반환 값:
또는 GEOMETRYGEOGRAPHY.인 문자열입니다.

ExecutionState 열거형

실행 중인 비동기 쿼리의 상태를 포함합니다.

패키지: 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 코드인 문자열
오류_메시지_가져오기
String getErrorMessage() throws SQLException
실패한 실행의 오류 메시지를 반환합니다.
반환 값:
오류 메시지인 문자열입니다.
  • Last updated on