Referencia de la API de Java para el controlador JDBC de Databricks (OSS)

En este artículo se proporciona documentación de referencia de API para databricks JDBC Driver (OSS).

Interfaz IDatabricksConnection

Describe los métodos para recuperar los identificadores de conexión y de ejecución de instrucciones.

Paquete: com.databricks.jdbc.api

getStatement
IDatabricksStatement getStatement(String statementId) throws SQLException Devuelve un identificador para un ID de instrucción determinado. Devoluciones: IDatabricksStatement para controlar una ejecución existente.

getConnectionId
String getConnectionId() throws SQLException Devuelve un identificador para la conexión de sesión. Devoluciones: Una cadena de texto que representa la conexión para la sesión subyacente de la ejecución.

Interfaz IDatabricksDriver

Describe los métodos para administrar la conexión del controlador.

Paquete: com.databricks.client.jdbc

com.databricks.client.jdbc.Driver extiende a com.databricks.client.jdbc.IDatabricksDriver y a java.sql.Driver.

cerrarConexión
void closeConnection(String url, Properties info, String connectionId) throws SQLException Cierra la conexión para el identificador de conexión especificado y la dirección URL de conexión JDBC. Devoluciones: Ninguno

Interfaz IDatabricksResultSet

Describe los métodos para recuperar los resultados de una consulta asincrónica.

Paquete: com.databricks.jdbc.api

getExecutionStatus
IExecutionStatus getExecutionStatus() throws SQLException Devuelve el estado de la ejecución. Devoluciones: IExecutionStatus que representa el estado de la ejecución

getStatementId
String getStatementId() throws SQLException Devuelve el identificador de instrucción asociado de la ejecución asincrónica. Devoluciones: Una cadena que representa el ID de la instrucción de la ejecución

Interfaz IDatabricksStatement

Describe los métodos para ejecutar y controlar una consulta asincrónica.

Paquete: com.databricks.jdbc.api

executeAsync
ResultSet executeAsync(String sql) throws SQLException Ejecuta un comando SQL en modo asincrónico. Parámetros: sql : comando que se va a ejecutar. Devoluciones: ResultSet que representa los resultados del SQL ejecutado.

obtenerResultadoDeEjecución
ResultSet getExecutionResult() throws SQLException Captura un estado y una respuesta de un comando SQL ya ejecutado y produce un error si no se ha ejecutado ningún comando. Se puede llamar a este método varias veces para sondear el estado de ejecución. Devoluciones: ResultSet que representa los resultados del SQL ejecutado.

Interfaz IDatabricksVolumeClient

Describe los métodos para administrar archivos en volúmenes de Catálogo de Unity.

Paquete: com.databricks.jdbc.api

prefixExists

boolean prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Determina si existe un prefijo específico (estructura similar a una carpeta) en el Unity Catalog. El prefijo debe formar parte del nombre de archivo. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume: nombre del volumen del catálogo de Unity del almacenamiento en la nube. prefix: prefijo para comprobar la existencia junto con la ruta de acceso relativa del volumen como directorio raíz. caseSensitive: si la comprobación debe distinguir mayúsculas de minúsculas o no. Devoluciones: Valor booleano que indica si el prefijo existe o no.

objectExists

boolean objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive) throws SQLException Determina si existe un objeto específico (archivo) en el volumen catálogo de Unity. El objeto debe coincidir exactamente con el nombre de archivo. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume: nombre del volumen del catálogo de Unity del almacenamiento en la nube. objectPath: la ruta de acceso del objeto (archivo) desde el volumen como directorio raíz para verificar la existencia dentro del volumen (dentro de cualquier subcarpeta). caseSensitive : un valor booleano que indica si la comprobación debe distinguir mayúsculas de minúsculas o no. Devoluciones: Valor booleano que indica si el objeto existe o no.

volumeExists

boolean volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive) throws SQLException Determina si existe un volumen específico en el catálogo y el esquema especificados. El volumen debe coincidir exactamente con el nombre del volumen. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volumeName : el nombre del volumen que se va a comprobar si existe. caseSensitive un valor booleano que indica si la comprobación debe distinguir mayúsculas de minúsculas o no. Devoluciones: Valor booleano que indica si el volumen existe o no.

listObjects

List<String> listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive) throws SQLException Devuelve la lista de todos los nombres de archivo del volumen catálogo de Unity que comienzan con un prefijo especificado. El prefijo debe formar parte de la ruta de acceso del archivo desde el volumen como directorio raíz. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. prefix : el prefijo de los nombres de archivo que se van a enumerar. Esto incluye la ruta de acceso relativa del volumen como directorio raíz. caseSensitive : un valor booleano que indica si la comprobación debe distinguir mayúsculas de minúsculas o no. Devoluciones: Lista de cadenas que indican los nombres de archivo que comienzan con el prefijo especificado.

getObject (archivo)

boolean getObject(String catalog, String schema, String volume, String objectPath, String localPath) throws SQLException Recupera un objeto (archivo) del volumen catálogo de Unity y lo almacena en la ruta de acceso local especificada. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. objectPath: la ruta de acceso del objeto (archivo) del volumen como directorio raíz. localPath : ruta de acceso local donde se almacenarán los datos recuperados. Devoluciones: Valor booleano que indica el estado de la GET operación.

getObject (flujo)

InputStreamEntity getObject(String catalog, String schema, String volume, String objectPath) throws SQLException Recupera un objeto como flujo de entrada del volumen catálogo de Unity. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. objectPath: la ruta de acceso del objeto (archivo) del volumen como directorio raíz. Devoluciones: Instancia de la entidad de flujo de entrada.

putObject (archivo)

boolean putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite) throws SQLException Carga datos desde una ruta de acceso local a una ruta de acceso especificada dentro de un volumen del catálogo de Unity. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. objectPath ruta de acceso de destino donde se cargará el objeto (archivo) desde el volumen como directorio raíz. localPath ruta de acceso local desde donde se van a cargar los datos. toOverwrite un valor booleano que indica si se va a sobrescribir el objeto si ya existe. Devoluciones: Valor booleano que indica el estado de la operación PUT.

putObject (flujo)

boolean putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite) throws SQLException Carga datos desde un flujo de entrada a una ruta de acceso especificada dentro de un volumen del catálogo de Unity. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. objectPath : la ruta de acceso de destino donde se va a cargar el objeto (archivo) desde el volumen como directorio raíz. inputStream : flujo de entrada desde donde se van a cargar los datos. contentLength : la longitud del flujo de entrada. toOverwrite un valor booleano que indica si se va a sobrescribir el objeto si ya existe. Devoluciones: Valor booleano que indica el estado de la operación PUT.

eliminarObjeto

boolean deleteObject(String catalog, String schema, String volume, String objectPath) throws SQLException Quita un objeto de una ruta de acceso especificada dentro de un volumen de catálogo de Unity. Parámetros: catalog : el nombre del catálogo del almacenamiento en la nube. schema : el nombre del esquema del almacenamiento en la nube. volume - el nombre del volumen UC del almacenamiento en la nube. objectPath: la ruta de acceso del objeto (archivo) del volumen como directorio raíz que se eliminará. Devoluciones: Valor booleano que indica el estado de la operación DELETE.

Enumeración ExecutionState

Contiene los estados de una consulta asincrónica en ejecución.

Paquete: com.databricks.jdbc.api

RUNNING	La instrucción se ejecuta en el servidor
PENDING	La instrucción aún no se ha ejecutado en el servidor
SUCCEEDED	La instrucción se ejecutó correctamente
FAILED	Fallo en la ejecución de la instrucción
ABORTED	Se anuló la declaración
CLOSED	Se cerró la instrucción

Interfaz IExecutionStatus

Describe los métodos para recuperar el estado de una consulta asincrónica.

Paquete: com.databricks.jdbc.api

getExecutionState
ExecutionState getExecutionState() throws SQLException Devuelve el estado de la ejecución. Devoluciones: ExecutionState que representa el estado del estado de ejecución

getSqlState
String getSqlState() throws SQLException Si se establece, devuelve el código SQLState para un estado de error. Devoluciones: Cadena que es el código SQLState

getErrorMessage
String getErrorMessage() throws SQLException Devuelve el mensaje de error de una ejecución con errores. Devoluciones: Una cadena que es el mensaje de error.