Package com.databricks.jdbc.api.impl.volume

Class DBFSVolumeClient

java.lang.Object

com.databricks.jdbc.api.impl.volume.DBFSVolumeClient

All Implemented Interfaces:

IDatabricksVolumeClient, Closeable, AutoCloseable

public class DBFSVolumeClient
extends Object
implements IDatabricksVolumeClient, Closeable

Implementation of Volume Client that directly calls SQL Exec API for the Volume Operations

Constructor Summary

Constructors

Constructor	Description
DBFSVolumeClient(IDatabricksConnectionContext connectionContext)
DBFSVolumeClient(com.databricks.sdk.WorkspaceClient workspaceClient)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	deleteObject(String catalog, String schema, String volume, String objectPath)	deleteObject(): Remove an object from a specified path within a UC Volume
org.apache.http.entity.InputStreamEntity	getObject(String catalog, String schema, String volume, String objectPath)	getObject(): Retrieves an object as input stream from the UC Volume
boolean	getObject(String catalog, String schema, String volume, String objectPath, String localPath)	getObject(): Retrieves an object (file) from the UC Volume and stores it in the local path
org.apache.http.entity.InputStreamEntity	getVolumeOperationInputStream()
List<String>	listObjects(String catalog, String schema, String volume, String prefix, boolean caseSensitive)	listObjects(): Lists all filenames in the UC Volume that start with a specified prefix.
boolean	objectExists(String catalog, String schema, String volume, String objectPath, boolean caseSensitive)	objectExists(): Determines if a specific object (file) exists in the UC Volume The object that we are looking for must match the file name exactly
boolean	prefixExists(String catalog, String schema, String volume, String prefix, boolean caseSensitive)	prefixExists(): Determines if a specific prefix (folder-like structure) exists in the UC Volume The prefix that we are looking for must be a part of the file name.
boolean	putObject(String catalog, String schema, String volume, String objectPath, InputStream inputStream, long contentLength, boolean toOverwrite)	putObject(): Upload data from an input stream to a specified path within a UC Volume.
boolean	putObject(String catalog, String schema, String volume, String objectPath, String localPath, boolean toOverwrite)	putObject(): Upload data from a local path to a specified path within a UC Volume.
void	setVolumeOperationEntityStream(org.apache.http.HttpEntity httpEntity)
boolean	volumeExists(String catalog, String schema, String volumeName, boolean caseSensitive)	volumeExists(): Determines if a specific volume exists in the given catalog and schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBFSVolumeClient

public DBFSVolumeClient(com.databricks.sdk.WorkspaceClient workspaceClient)

DBFSVolumeClient

public DBFSVolumeClient(IDatabricksConnectionContext connectionContext)

Method Detail

prefixExists

public boolean prefixExists(String catalog,
                            String schema,
                            String volume,
                            String prefix,
                            boolean caseSensitive)
                     throws DatabricksSQLFeatureNotImplementedException

prefixExists(): Determines if a specific prefix (folder-like structure) exists in the UC Volume The prefix that we are looking for must be a part of the file name.

Specified by:

prefixExists in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

prefix - the prefix to check for existence along with the relative path from the volume as the root directory

caseSensitive - a boolean indicating whether the check should be case-sensitive or not

Returns:

a boolean indicating whether the prefix exists or not

Throws:

DatabricksSQLFeatureNotImplementedException

objectExists

public boolean objectExists(String catalog,
                            String schema,
                            String volume,
                            String objectPath,
                            boolean caseSensitive)
                     throws DatabricksSQLException

objectExists(): Determines if a specific object (file) exists in the UC Volume The object that we are looking for must match the file name exactly

Specified by:

objectExists in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the path of the object (file) from the volume as the root directory to check for existence within the volume (inside any sub-folder)

caseSensitive - a boolean indicating whether the check should be case-sensitive or not

Returns:

a boolean indicating whether the object exists or not

Throws:

DatabricksSQLException

volumeExists

public boolean volumeExists(String catalog,
                            String schema,
                            String volumeName,
                            boolean caseSensitive)
                     throws DatabricksSQLException

volumeExists(): Determines if a specific volume exists in the given catalog and schema. The volume that we are looking for must match the volume name exactly.

Specified by:

volumeExists in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volumeName - the name of the volume to check for existence

caseSensitive - a boolean indicating whether the check should be case-sensitive or not

Returns:

a boolean indicating whether the volume exists or not

Throws:

DatabricksSQLException

listObjects

public List<String> listObjects(String catalog,
                                String schema,
                                String volume,
                                String prefix,
                                boolean caseSensitive)
                         throws SQLException

listObjects(): Lists all filenames in the UC Volume that start with a specified prefix. The prefix that we are looking for must be a part of the file path from the volume as the root.

Specified by:

listObjects in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

prefix - the prefix of the filenames to list. This includes the relative path from the volume as the root directory

caseSensitive - a boolean indicating whether the check should be case-sensitive or not

Returns:

a list of strings indicating the filenames that start with the specified prefix

Throws:

SQLException

getObject

public boolean getObject(String catalog,
                         String schema,
                         String volume,
                         String objectPath,
                         String localPath)
                  throws DatabricksVolumeOperationException

getObject(): Retrieves an object (file) from the UC Volume and stores it in the local path

Specified by:

getObject in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the path of the object (file) from the volume as the root directory

localPath - the local path where the retrieved data is to be stored

Returns:

a boolean value indicating status of the GET operation

Throws:

DatabricksVolumeOperationException

getObject

public org.apache.http.entity.InputStreamEntity getObject(String catalog,
                                                          String schema,
                                                          String volume,
                                                          String objectPath)
                                                   throws DatabricksVolumeOperationException

getObject(): Retrieves an object as input stream from the UC Volume

Specified by:

getObject in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the path of the object (file) from the volume as the root directory

Returns:

an instance of input stream entity

Throws:

DatabricksVolumeOperationException

putObject

public boolean putObject(String catalog,
                         String schema,
                         String volume,
                         String objectPath,
                         String localPath,
                         boolean toOverwrite)
                  throws DatabricksVolumeOperationException

putObject(): Upload data from a local path to a specified path within a UC Volume.

Specified by:

putObject in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the destination path where the object (file) is to be uploaded from the volume as the root directory

localPath - the local path from where the data is to be uploaded

toOverwrite - a boolean indicating whether to overwrite the object if it already exists

Returns:

a boolean value indicating status of the PUT operation

Throws:

DatabricksVolumeOperationException

putObject

public boolean putObject(String catalog,
                         String schema,
                         String volume,
                         String objectPath,
                         InputStream inputStream,
                         long contentLength,
                         boolean toOverwrite)
                  throws DatabricksVolumeOperationException

putObject(): Upload data from an input stream to a specified path within a UC Volume.

Specified by:

putObject in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the destination path where the object (file) is to be uploaded from the volume as the root directory

inputStream - the input stream from where the data is to be uploaded

contentLength - the length of the input stream

toOverwrite - a boolean indicating whether to overwrite the object if it already exists

Returns:

a boolean value indicating status of the PUT operation

Throws:

DatabricksVolumeOperationException

deleteObject

public boolean deleteObject(String catalog,
                            String schema,
                            String volume,
                            String objectPath)
                     throws DatabricksVolumeOperationException

deleteObject(): Remove an object from a specified path within a UC Volume

Specified by:

deleteObject in interface IDatabricksVolumeClient

Parameters:

catalog - the catalog name of the cloud storage

schema - the schema name of the cloud storage

volume - the UC volume name of the cloud storage

objectPath - the path of the object (file) from the volume as the root directory to delete

Returns:

a boolean value indicating status of the DELETE operation

Throws:

DatabricksVolumeOperationException

setVolumeOperationEntityStream

public void setVolumeOperationEntityStream(org.apache.http.HttpEntity httpEntity)
                                    throws IOException

Throws:

IOException

getVolumeOperationInputStream

public org.apache.http.entity.InputStreamEntity getVolumeOperationInputStream()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException