你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DataLakeFileClient 类

参考

包:: com.azure.storage.file.datalake

Maven 项目:: com.azure:azure-storage-file-datalake:12.18.4

java.lang.Object
- com.azure.storage.file.datalake.DataLakePathClient
- - com.azure.storage.file.datalake.DataLakeFileClient

public class DataLakeFileClient
extends DataLakePathClient

此类提供包含 Azure 存储 Data Lake 的文件操作的客户端。此客户端提供的操作包括创建文件、删除文件、重命名文件、设置元数据和 http 标头、设置和检索访问控制、获取属性、读取文件以及追加和刷新数据以写入文件。

此客户端通过 DataLakePathClientBuilder 实例化或通过检索 getFileClient(String fileName)。

有关详细信息，请参阅 Azure Docs 。

方法摘要

修饰符和类型	方法和描述
void	append(BinaryData data, long fileOffset) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
void	append(InputStream data, long fileOffset, long length) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
Response<Void>	appendWithResponse(BinaryData data, long fileOffset, byte[] contentMd5, String leaseId, Duration timeout, Context context) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
Response<Void>	appendWithResponse(BinaryData data, long fileOffset, DataLakeFileAppendOptions appendOptions, Duration timeout, Context context) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
Response<Void>	appendWithResponse(InputStream data, long fileOffset, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
Response<Void>	appendWithResponse(InputStream data, long fileOffset, long length, DataLakeFileAppendOptions appendOptions, Duration timeout, Context context) 将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入
void	delete() 删除文件。
boolean	deleteIfExists() 删除文件（如果存在）。
Response<Boolean>	deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context) 删除文件（如果存在）。
Response<Void>	deleteWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context) 删除文件。
PathInfo	flush(long position) 已放弃请参阅 flush(long position, boolean overwrite)。刷新 (写入之前通过对追加的调用追加到文件的数据) 。
PathInfo	flush(long position, boolean overwrite) 刷新 (写入之前通过追加调用追加到文件) 数据。
Response<PathInfo>	flushWithResponse(long position, boolean retainUncommittedData, boolean close, PathHttpHeaders httpHeaders, DataLakeRequestConditions requestConditions, Duration timeout, Context context) 刷新 (写入之前通过追加调用追加到文件) 数据。
Response<PathInfo>	flushWithResponse(long position, DataLakeFileFlushOptions flushOptions, Duration timeout, Context context) 刷新 (写入之前通过追加调用追加到文件) 数据。
DataLakeFileClient	getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey) 使用指定的 DataLakeFileClient 创建一个新的 `customerProvidedKey`。
String	getFileName() 获取此文件的名称，不包括其完整路径。
String	getFilePath() 获取此文件的路径，不包括资源本身的名称。
String	getFileUrl() 获取此客户端在 Data Lake 服务上表示的文件的 URL。
OutputStream	getOutputStream() 创建并打开输出流以将数据写入文件。
OutputStream	getOutputStream(DataLakeFileOutputStreamOptions options) 创建并打开输出流以将数据写入文件。
OutputStream	getOutputStream(DataLakeFileOutputStreamOptions options, Context context) 创建并打开输出流以将数据写入文件。
DataLakeFileOpenInputStreamResult	openInputStream() 打开文件输入流以下载文件。
DataLakeFileOpenInputStreamResult	openInputStream(DataLakeFileInputStreamOptions options) 打开文件输入流以下载文件的指定范围。
DataLakeFileOpenInputStreamResult	openInputStream(DataLakeFileInputStreamOptions options, Context context) 打开文件输入流以下载文件的指定范围。
InputStream	openQueryInputStream(String expression) 打开输入流以查询文件。
Response<InputStream>	openQueryInputStreamWithResponse(FileQueryOptions queryOptions) 打开输入流以查询文件。
void	query(OutputStream stream, String expression) 将整个文件查询到输出流中。
FileQueryResponse	queryWithResponse(FileQueryOptions queryOptions, Duration timeout, Context context) 将整个文件查询到输出流中。
void	read(OutputStream stream) 将整个文件读取到输出流中。
PathProperties	readToFile(String filePath) 将整个文件读取到路径指定的文件中。
PathProperties	readToFile(String filePath, boolean overwrite) 将整个文件读取到路径指定的文件中。
Response<PathProperties>	readToFileWithResponse(String filePath, FileRange range, ParallelTransferOptions parallelTransferOptions, DownloadRetryOptions downloadRetryOptions, DataLakeRequestConditions requestConditions, boolean rangeGetContentMd5, Set<OpenOption> openOptions, Duration timeout, Context context) 将整个文件读取到路径指定的文件中。
FileReadResponse	readWithResponse(OutputStream stream, FileRange range, DownloadRetryOptions options, DataLakeRequestConditions requestConditions, boolean getRangeContentMd5, Duration timeout, Context context) 将文件中的一系列字节读取到输出流中。
DataLakeFileClient	rename(String destinationFileSystem, String destinationPath) 将文件移动到文件系统中的另一个位置。
Response<DataLakeFileClient>	renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context) 将文件移动到文件系统中的另一个位置。
void	scheduleDeletion(FileScheduleDeletionOptions options) 计划要删除的文件。
Response<Void>	scheduleDeletionWithResponse(FileScheduleDeletionOptions options, Duration timeout, Context context) 计划要删除的文件。
PathInfo	upload(BinaryData data) 创建新文件。
PathInfo	upload(BinaryData data, boolean overwrite) 创建新文件，或更新现有文件的内容。
PathInfo	upload(InputStream data, long length) 创建新文件。
PathInfo	upload(InputStream data, long length, boolean overwrite) 创建新文件，或更新现有文件的内容。
void	uploadFromFile(String filePath) 使用指定文件的内容创建文件。
void	uploadFromFile(String filePath, boolean overwrite) 使用指定文件的内容创建文件。
void	uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout) 使用指定文件的内容创建文件。
Response<PathInfo>	uploadFromFileWithResponse(String filePath, ParallelTransferOptions parallelTransferOptions, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context) 使用指定文件的内容创建文件。
Response<PathInfo>	uploadWithResponse(FileParallelUploadOptions options, Duration timeout, Context context) 创建新文件。

方法继承自 DataLakePathClient

create create createIfNotExists createIfNotExistsWithResponse createWithResponse createWithResponse deleteIfExists deleteIfExistsWithResponse exists existsWithResponse generateSas generateSas generateUserDelegationSas generateUserDelegationSas getAccessControl getAccessControlWithResponse getAccountName getCustomerProvidedKey getCustomerProvidedKeyClient getFileSystemName getHttpPipeline getProperties getPropertiesWithResponse getServiceVersion removeAccessControlRecursive removeAccessControlRecursiveWithResponse setAccessControlList setAccessControlListWithResponse setAccessControlRecursive setAccessControlRecursiveWithResponse setHttpHeaders setHttpHeadersWithResponse setMetadata setMetadataWithResponse setPermissions setPermissionsWithResponse updateAccessControlRecursive updateAccessControlRecursiveWithResponse

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

append

public void append(BinaryData data, long fileOffset)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

client.append(binaryData, offset);
 System.out.println("Append data completed");

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

append

public void append(InputStream data, long fileOffset, long length)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

client.append(data, offset, length);
 System.out.println("Append data completed");

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

length - 数据的确切长度。

appendWithResponse

public Response appendWithResponse(BinaryData data, long fileOffset, byte[] contentMd5, String leaseId, Duration timeout, Context context)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

FileRange range = new FileRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5

 Response<Void> response = client.appendWithResponse(binaryData, offset, contentMd5, leaseId, timeout,
     new Context(key1, value1));
 System.out.printf("Append data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

contentMd5 - 数据内容的 MD5 哈希。如果指定，服务将计算收到的数据的 MD5，如果请求与提供的 MD5 不匹配，则请求将失败。

leaseId - 通过设置租约 ID，如果提供的租约与文件中的活动租约不匹配，请求将失败。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

表示完成的响应。

appendWithResponse

public Response appendWithResponse(BinaryData data, long fileOffset, DataLakeFileAppendOptions appendOptions, Duration timeout, Context context)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

BinaryData binaryData = BinaryData.fromStream(data, length);
 FileRange range = new FileRange(1024, 2048L);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5
 DataLakeFileAppendOptions appendOptions = new DataLakeFileAppendOptions()
     .setLeaseId(leaseId)
     .setContentHash(contentMd5)
     .setFlush(true);
 Response<Void> response = client.appendWithResponse(binaryData, offset, appendOptions, timeout,
     new Context(key1, value1));
 System.out.printf("Append data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

appendOptions - DataLakeFileAppendOptions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

表示完成的响应。

appendWithResponse

public Response appendWithResponse(InputStream data, long fileOffset, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

FileRange range = new FileRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5

 Response<Void> response = client.appendWithResponse(data, offset, length, contentMd5, leaseId, timeout,
     new Context(key1, value1));
 System.out.printf("Append data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

length - 数据的确切长度。

contentMd5 - 数据内容的 MD5 哈希。如果指定，服务将计算收到的数据的 MD5，如果请求与提供的 MD5 不匹配，则请求将失败。

leaseId - 通过设置租约 ID，如果提供的租约与文件中的活动租约不匹配，请求将失败。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

表示完成的响应。

appendWithResponse

public Response appendWithResponse(InputStream data, long fileOffset, long length, DataLakeFileAppendOptions appendOptions, Duration timeout, Context context)

将数据追加到指定的资源，以便稍后刷新 (通过调用刷新) 写入

示例代码

FileRange range = new FileRange(1024, 2048L);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5
 DataLakeFileAppendOptions appendOptions = new DataLakeFileAppendOptions()
     .setLeaseId(leaseId)
     .setContentHash(contentMd5)
     .setFlush(true);
 Response<Void> response = client.appendWithResponse(data, offset, length, appendOptions, timeout,
     new Context(key1, value1));
 System.out.printf("Append data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

data - 要写入文件的数据。

fileOffset - 要追加数据的位置。

length - 数据的确切长度。

appendOptions - DataLakeFileAppendOptions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

表示完成的响应。

delete

public void delete()

删除文件。

示例代码

client.delete();
 System.out.println("Delete request completed");

有关详细信息，请参阅 Azure Docs

deleteIfExists

public boolean deleteIfExists()

删除文件（如果存在）。

示例代码

client.deleteIfExists();
 System.out.println("Delete request completed");

有关详细信息，请参阅 Azure Docs

Overrides:

DataLakeFileClient.deleteIfExists()

Returns:

true 如果文件成功删除，则为 ; false 如果文件不存在，则为。

deleteIfExistsWithResponse

public Response deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

删除文件（如果存在）。

示例代码

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(false)
     .setRequestConditions(requestConditions);

 Response<Boolean> response = client.deleteIfExistsWithResponse(options, timeout, new Context(key1, value1));
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

有关详细信息，请参阅 Azure Docs

Overrides:

DataLakeFileClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

Parameters:

options - DataLakePathDeleteOptions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含状态代码和 HTTP 标头的响应。如果 Response<T>的状态代码为 200，则表示文件已成功删除。如果状态代码为 404，则该文件不存在。

deleteWithResponse

public Response deleteWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context)

删除文件。

示例代码

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);

 client.deleteWithResponse(requestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

有关详细信息，请参阅 Azure Docs

Parameters:

requestConditions - DataLakeRequestConditions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含状态代码和 HTTP 标头的响应。

flush

@Deprecated
public PathInfo flush(long position)

已放弃

请参阅 flush(long position, boolean overwrite)。

刷新 (写入之前通过对追加的调用追加到文件的数据) 。以前上传的数据必须是连续的。

默认情况下，此方法不会覆盖现有数据。

示例代码

client.flush(position);
 System.out.println("Flush data completed");

有关详细信息，请参阅 Azure Docs

Parameters:

position - 写入所有数据后文件的长度。

Returns:

有关创建的资源的信息。

flush

public PathInfo flush(long position, boolean overwrite)

刷新 (写入之前通过对追加的调用追加到文件的数据) 。以前上传的数据必须是连续的。

示例代码

boolean overwrite = true;
 client.flush(position, overwrite);
 System.out.println("Flush data completed");

有关详细信息，请参阅 Azure Docs

Parameters:

position - 写入所有数据后文件的长度。

overwrite - 是否覆盖文件上是否存在数据。

Returns:

有关所创建资源的信息。

flushWithResponse

public Response flushWithResponse(long position, boolean retainUncommittedData, boolean close, PathHttpHeaders httpHeaders, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

刷新 (写入之前通过追加调用追加到文件) 数据。以前上传的数据必须是连续的。

示例代码

FileRange range = new FileRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5
 boolean retainUncommittedData = false;
 boolean close = false;
 PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);

 Response<PathInfo> response = client.flushWithResponse(position, retainUncommittedData, close, httpHeaders,
     requestConditions, timeout, new Context(key1, value1));
 System.out.printf("Flush data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

position - 写入所有数据后文件的长度。

retainUncommittedData - 操作后是否保留未提交的数据。

close - 引发的文件更改事件是否指示完成 (true) 或修改 (false) 。

httpHeaders - PathHttpHeaders

requestConditions - DataLakeRequestConditions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含所创建资源信息的响应。

flushWithResponse

public Response flushWithResponse(long position, DataLakeFileFlushOptions flushOptions, Duration timeout, Context context)

刷新 (写入之前通过追加调用追加到文件) 数据。以前上传的数据必须是连续的。

示例代码

FileRange range = new FileRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);
 byte[] contentMd5 = new byte[0]; // Replace with valid md5
 boolean retainUncommittedData = false;
 boolean close = false;
 PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);

 Integer leaseDuration = 15;

 DataLakeFileFlushOptions flushOptions = new DataLakeFileFlushOptions()
     .setUncommittedDataRetained(retainUncommittedData)
     .setClose(close)
     .setPathHttpHeaders(httpHeaders)
     .setRequestConditions(requestConditions)
     .setLeaseAction(LeaseAction.ACQUIRE)
     .setLeaseDuration(leaseDuration)
     .setProposedLeaseId(leaseId);

 Response<PathInfo> response = client.flushWithResponse(position, flushOptions, timeout,
     new Context(key1, value1));
 System.out.printf("Flush data completed with status %d%n", response.getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

position - 写入所有数据后文件的长度。

flushOptions - DataLakeFileFlushOptions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含所创建资源信息的响应。

getCustomerProvidedKeyClient

public DataLakeFileClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

使用指定的 DataLakeFileClient 创建一个新的 customerProvidedKey。

Overrides:

DataLakeFileClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Parameters:

customerProvidedKey - CustomerProvidedKey对于 Blob，传递null以使用任何客户提供的密钥。

Returns:

具有 DataLakeFileClient 指定 customerProvidedKey的。

getFileName

public String getFileName()

获取此文件的名称，不包括其完整路径。

Returns:

文件的名称。

getFilePath

public String getFilePath()

获取此文件的路径，不包括资源本身的名称。

Returns:

文件的路径。

getFileUrl

public String getFileUrl()

获取此客户端在 Data Lake 服务上表示的文件的 URL。

Returns:

URL。

getOutputStream

public OutputStream getOutputStream()

创建并打开输出流以将数据写入文件。如果服务上已存在该文件，则会覆盖该文件。

Returns:

OutputStream可用于写入文件的。

getOutputStream

public OutputStream getOutputStream(DataLakeFileOutputStreamOptions options)

创建并打开输出流以将数据写入文件。如果服务上已存在该文件，则会覆盖该文件。

若要避免覆盖，请将“*”传递给 setIfNoneMatch(String ifNoneMatch)。

Parameters:

options - DataLakeFileOutputStreamOptions

Returns:

OutputStream可用于写入文件的。

getOutputStream

public OutputStream getOutputStream(DataLakeFileOutputStreamOptions options, Context context)

创建并打开输出流以将数据写入文件。如果服务上已存在该文件，则会覆盖该文件。

若要避免覆盖，请将“*”传递给 setIfNoneMatch(String ifNoneMatch)。

Parameters:

options - DataLakeFileOutputStreamOptions

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

OutputStream可用于写入文件的。

openInputStream

public DataLakeFileOpenInputStreamResult openInputStream()

打开文件输入流以下载文件。锁定 ETag。

DataLakeFileOpenInputStreamResult inputStream = client.openInputStream();

Returns:

一个 InputStream 对象，表示要用于从文件读取的流。

openInputStream

public DataLakeFileOpenInputStreamResult openInputStream(DataLakeFileInputStreamOptions options)

打开文件输入流以下载文件的指定范围。如果未指定选项，则默认为 ETag 锁定。

DataLakeFileInputStreamOptions options = new DataLakeFileInputStreamOptions().setBlockSize(1024)
     .setRequestConditions(new DataLakeRequestConditions());
 DataLakeFileOpenInputStreamResult streamResult = client.openInputStream(options);

Parameters:

options - DataLakeFileInputStreamOptions

Returns:

一个 DataLakeFileOpenInputStreamResult 对象，该对象包含要用于从文件读取的流。

openInputStream

public DataLakeFileOpenInputStreamResult openInputStream(DataLakeFileInputStreamOptions options, Context context)

打开文件输入流以下载文件的指定范围。如果未指定选项，则默认为 ETag 锁定。

options = new DataLakeFileInputStreamOptions().setBlockSize(1024)
     .setRequestConditions(new DataLakeRequestConditions());
 DataLakeFileOpenInputStreamResult stream = client.openInputStream(options, new Context(key1, value1));

Parameters:

options - DataLakeFileInputStreamOptions

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

一个 DataLakeFileOpenInputStreamResult 对象，该对象包含要用于从文件读取的流。

openQueryInputStream

public InputStream openQueryInputStream(String expression)

打开输入流以查询文件。

有关详细信息，请参阅 Azure Docs

示例代码

String expression = "SELECT * from BlobStorage";
 InputStream inputStream = client.openQueryInputStream(expression);
 // Now you can read from the input stream like you would normally.

Parameters:

expression - 查询表达式。

Returns:

一个 InputStream 对象，表示用于读取查询响应的流。

openQueryInputStreamWithResponse

public Response openQueryInputStreamWithResponse(FileQueryOptions queryOptions)

打开输入流以查询文件。

有关详细信息，请参阅 Azure Docs

示例代码

String expression = "SELECT * from BlobStorage";
 FileQuerySerialization input = new FileQueryDelimitedSerialization()
     .setColumnSeparator(',')
     .setEscapeChar('\n')
     .setRecordSeparator('\n')
     .setHeadersPresent(true)
     .setFieldQuote('"');
 FileQuerySerialization output = new FileQueryJsonSerialization()
     .setRecordSeparator('\n');
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId("leaseId");
 Consumer<FileQueryError> errorConsumer = System.out::println;
 Consumer<FileQueryProgress> progressConsumer = progress -> System.out.println("total file bytes read: "
     + progress.getBytesScanned());
 FileQueryOptions queryOptions = new FileQueryOptions(expression)
     .setInputSerialization(input)
     .setOutputSerialization(output)
     .setRequestConditions(requestConditions)
     .setErrorConsumer(errorConsumer)
     .setProgressConsumer(progressConsumer);

 InputStream inputStream = client.openQueryInputStreamWithResponse(queryOptions).getValue();
 // Now you can read from the input stream like you would normally.

Parameters:

queryOptions - FileQueryOptions.

Returns:

包含状态代码和 HTTP 标头的响应，包括 InputStream 表示用于读取查询响应的流的对象。

query

public void query(OutputStream stream, String expression)

将整个文件查询到输出流中。

有关详细信息，请参阅 Azure Docs

示例代码

ByteArrayOutputStream queryData = new ByteArrayOutputStream();
 String expression = "SELECT * from BlobStorage";
 client.query(queryData, expression);
 System.out.println("Query completed.");

Parameters:

stream - 一个非 null OutputStream 实例，其中将写入下载的数据。

expression - 查询表达式。

queryWithResponse

public FileQueryResponse queryWithResponse(FileQueryOptions queryOptions, Duration timeout, Context context)

将整个文件查询到输出流中。

有关详细信息，请参阅 Azure Docs

示例代码

ByteArrayOutputStream queryData = new ByteArrayOutputStream();
 String expression = "SELECT * from BlobStorage";
 FileQueryJsonSerialization input = new FileQueryJsonSerialization()
     .setRecordSeparator('\n');
 FileQueryDelimitedSerialization output = new FileQueryDelimitedSerialization()
     .setEscapeChar('\0')
     .setColumnSeparator(',')
     .setRecordSeparator('\n')
     .setFieldQuote('\'')
     .setHeadersPresent(true);
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions().setLeaseId(leaseId);
 Consumer<FileQueryError> errorConsumer = System.out::println;
 Consumer<FileQueryProgress> progressConsumer = progress -> System.out.println("total file bytes read: "
     + progress.getBytesScanned());
 FileQueryOptions queryOptions = new FileQueryOptions(expression, queryData)
     .setInputSerialization(input)
     .setOutputSerialization(output)
     .setRequestConditions(requestConditions)
     .setErrorConsumer(errorConsumer)
     .setProgressConsumer(progressConsumer);
 System.out.printf("Query completed with status %d%n",
     client.queryWithResponse(queryOptions, timeout, new Context(key1, value1))
         .getStatusCode());

Parameters:

queryOptions - FileQueryOptions.

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含状态代码和 HTTP 标头的响应。

read

public void read(OutputStream stream)

将整个文件读取到输出流中。

示例代码

client.read(new ByteArrayOutputStream());
 System.out.println("Download completed.");

有关详细信息，请参阅 Azure Docs

Parameters:

stream - 一个非 null OutputStream 实例，其中将写入下载的数据。

readToFile

public PathProperties readToFile(String filePath)

将整个文件读取到路径指定的文件中。

该文件将创建且不得存在，如果文件已存在， FileAlreadyExistsException 则会引发。

示例代码

client.readToFile(file);
 System.out.println("Completed download to file");

有关详细信息，请参阅 Azure Docs

Parameters:

filePath - 一个 String ，表示将写入下载的数据的 filePath。

Returns:

文件属性和元数据。

readToFile

public PathProperties readToFile(String filePath, boolean overwrite)

将整个文件读取到路径指定的文件中。

如果 overwrite 设置为 false，则将创建文件，并且必须不存在，如果文件已存在， FileAlreadyExistsException 则会引发。

示例代码

boolean overwrite = false; // Default value
 client.readToFile(file, overwrite);
 System.out.println("Completed download to file");

有关详细信息，请参阅 Azure Docs

Parameters:

filePath - 一个 String ，表示将写入下载的数据的 filePath。

overwrite - 如果文件存在，是否覆盖文件。

Returns:

文件属性和元数据。

readToFileWithResponse

public Response readToFileWithResponse(String filePath, FileRange range, ParallelTransferOptions parallelTransferOptions, DownloadRetryOptions downloadRetryOptions, DataLakeRequestConditions requestConditions, boolean rangeGetContentMd5, Set openOptions, Duration timeout, Context context)

将整个文件读取到路径指定的文件中。

默认情况下，将创建文件，并且不得存在，如果文件已存在， FileAlreadyExistsException 则会引发。若要替代此行为，请提供适当的 OpenOptions

示例代码

FileRange fileRange = new FileRange(1024, 2048L);
 DownloadRetryOptions downloadRetryOptions = new DownloadRetryOptions().setMaxRetryRequests(5);
 Set<OpenOption> openOptions = new HashSet<>(Arrays.asList(StandardOpenOption.CREATE_NEW,
     StandardOpenOption.WRITE, StandardOpenOption.READ)); // Default options

 client.readToFileWithResponse(file, fileRange, new ParallelTransferOptions().setBlockSizeLong(4L * Constants.MB),
     downloadRetryOptions, null, false, openOptions, timeout, new Context(key2, value2));
 System.out.println("Completed download to file");

有关详细信息，请参阅 Azure Docs

Parameters:

filePath - 一个 String ，表示将写入下载的数据的 filePath。

range - FileRange

parallelTransferOptions - ParallelTransferOptions 用于下载到文件。忽略并行传输参数的数目。

downloadRetryOptions - DownloadRetryOptions

requestConditions - DataLakeRequestConditions

rangeGetContentMd5 - 是否应返回指定文件范围的 contentMD5。

openOptions - OpenOptions ，用于配置如何打开或创建文件。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含文件属性和元数据的响应。

readWithResponse

public FileReadResponse readWithResponse(OutputStream stream, FileRange range, DownloadRetryOptions options, DataLakeRequestConditions requestConditions, boolean getRangeContentMd5, Duration timeout, Context context)

将文件中的一系列字节读取到输出流中。

示例代码

FileRange range = new FileRange(1024, 2048L);
 DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);

 System.out.printf("Download completed with status %d%n",
     client.readWithResponse(new ByteArrayOutputStream(), range, options, null, false,
         timeout, new Context(key2, value2)).getStatusCode());

有关详细信息，请参阅 Azure Docs

Parameters:

stream - 一个非 null OutputStream 实例，其中将写入下载的数据。

range - FileRange

options - DownloadRetryOptions

requestConditions - DataLakeRequestConditions

getRangeContentMd5 - 是否应返回指定文件范围的 contentMD5。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含状态代码和 HTTP 标头的响应。

rename

public DataLakeFileClient rename(String destinationFileSystem, String destinationPath)

将文件移动到文件系统中的另一个位置。有关详细信息，请参阅 Azure Docs。

示例代码

DataLakeDirectoryAsyncClient renamedClient = client.rename(fileSystemName, destinationPath).block();
 System.out.println("Directory Client has been renamed");

Parameters:

destinationFileSystem - 帐户中目标文件系统。 null ，用于当前文件系统。

destinationPath - 从文件系统将文件重命名为的相对路径不包括文件系统名称。例如，如果要将 fileSystem = “myfilesystem”的文件，path = “mydir/hello.txt”移动到 myfilesystem (中的另一个路径，例如：newdir/hi.txt) 然后设置 destinationPath = “newdir/hi.txt”

Returns:

DataLakeFileClient用于与创建的新文件交互的。

renameWithResponse

public Response renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context)

将文件移动到文件系统中的另一个位置。有关详细信息，请参阅 Azure Docs。

示例代码

DataLakeRequestConditions sourceRequestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 DataLakeRequestConditions destinationRequestConditions = new DataLakeRequestConditions();

 DataLakeFileClient newRenamedClient = client.renameWithResponse(fileSystemName, destinationPath,
     sourceRequestConditions, destinationRequestConditions, timeout, new Context(key1, value1)).getValue();
 System.out.println("Directory Client has been renamed");

Parameters:

destinationFileSystem - 帐户中目标文件系统。 null ，用于当前文件系统。

sourceRequestConditions - DataLakeRequestConditions 针对源。

destinationRequestConditions - DataLakeRequestConditions 针对目标。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

一个 Response<T> ，它 value 包含 DataLakeFileClient 用于与创建的文件交互的。

scheduleDeletion

public void scheduleDeletion(FileScheduleDeletionOptions options)

计划要删除的文件。

示例代码

FileScheduleDeletionOptions options = new FileScheduleDeletionOptions(OffsetDateTime.now().plusDays(1));
 client.scheduleDeletion(options);
 System.out.println("File deletion has been scheduled");

Parameters:

options - 计划删除参数。

scheduleDeletionWithResponse

public Response scheduleDeletionWithResponse(FileScheduleDeletionOptions options, Duration timeout, Context context)

计划要删除的文件。

示例代码

FileScheduleDeletionOptions options = new FileScheduleDeletionOptions(OffsetDateTime.now().plusDays(1));
 Context context = new Context("key", "value");

 client.scheduleDeletionWithResponse(options, timeout, context);
 System.out.println("File deletion has been scheduled");

Parameters:

options - 计划删除参数。

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含状态代码和 HTTP 标头的响应。

upload

public PathInfo upload(BinaryData data)

创建新文件。默认情况下，此方法不会覆盖现有文件。

示例代码

try {
     client.upload(binaryData);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

data - 要写入 Blob 的数据。数据必须是可标记的。这是为了支持重试。如果数据不可标记，请考虑将数据源包装在 BufferedInputStream 中以添加标记支持。

Returns:

有关上传的路径的信息。

upload

public PathInfo upload(BinaryData data, boolean overwrite)

创建新文件，或更新现有文件的内容。

示例代码

try {
     boolean overwrite = false;
     client.upload(binaryData, overwrite);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

data - 要写入 Blob 的数据。数据必须是可标记的。这是为了支持重试。如果数据不可标记，请考虑将数据源包装在 BufferedInputStream 中以添加标记支持。

overwrite - 是否覆盖文件上是否存在数据。

Returns:

有关上传的路径的信息。

upload

public PathInfo upload(InputStream data, long length)

创建新文件。默认情况下，此方法不会覆盖现有文件。

示例代码

try {
     client.upload(data, length);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

data - 要写入 Blob 的数据。数据必须是可标记的。这是为了支持重试。如果数据不可标记，请考虑将数据源包装在 BufferedInputStream 中以添加标记支持。

length - 数据的确切长度。此值必须与中 InputStream提供的数据的长度精确匹配，

Returns:

有关上传的路径的信息。

upload

public PathInfo upload(InputStream data, long length, boolean overwrite)

创建新文件，或更新现有文件的内容。

示例代码

try {
     boolean overwrite = false;
     client.upload(data, length, overwrite);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

data - 要写入 Blob 的数据。数据必须是可标记的。这是为了支持重试。如果数据不可标记，请考虑将数据源包装在 BufferedInputStream 中以添加标记支持。

length - 数据的确切长度。此值必须与中 InputStream提供的数据的长度精确匹配，

overwrite - 是否覆盖文件上是否存在数据。

Returns:

有关上传的路径的信息。

uploadFromFile

public void uploadFromFile(String filePath)

使用指定文件的内容创建文件。默认情况下，此方法不会覆盖现有文件。

示例代码

try {
     client.uploadFromFile(filePath);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - 要上传的文件的路径

uploadFromFile

public void uploadFromFile(String filePath, boolean overwrite)

使用指定文件的内容创建文件。

示例代码

try {
     boolean overwrite = false;
     client.uploadFromFile(filePath, overwrite);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - 要上传的文件的路径

overwrite - 是否覆盖文件（如果文件已存在）

uploadFromFile

public void uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout)

使用指定文件的内容创建文件。

若要避免覆盖，请将“*”传递给 setIfNoneMatch(String ifNoneMatch)。

示例代码

PathHttpHeaders headers = new PathHttpHeaders()
     .setContentMd5("data".getBytes(StandardCharsets.UTF_8))
     .setContentLanguage("en-US")
     .setContentType("binary");

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Long blockSize = 100L * 1024L * 1024L; // 100 MB;
 ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);

 try {
     client.uploadFromFile(filePath, parallelTransferOptions, headers, metadata, requestConditions, timeout);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - 要上传的文件的路径

parallelTransferOptions - ParallelTransferOptions 用于配置缓冲上传。

headers - PathHttpHeaders

metadata - 要与资源关联的元数据。如果任何元数据键或值中都有前导或尾随空格，则必须将其删除或编码。

requestConditions - DataLakeRequestConditions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

uploadFromFileWithResponse

public Response uploadFromFileWithResponse(String filePath, ParallelTransferOptions parallelTransferOptions, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

使用指定文件的内容创建文件。

若要避免覆盖，请将“*”传递给 setIfNoneMatch(String ifNoneMatch)。

示例代码

PathHttpHeaders headers = new PathHttpHeaders()
     .setContentMd5("data".getBytes(StandardCharsets.UTF_8))
     .setContentLanguage("en-US")
     .setContentType("binary");

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Long blockSize = 100L * 1024L * 1024L; // 100 MB;
 ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);

 try {
     Response<PathInfo> response = client.uploadFromFileWithResponse(filePath, parallelTransferOptions, headers,
         metadata, requestConditions, timeout, new Context("key", "value"));
     System.out.printf("Upload from file succeeded with status %d%n", response.getStatusCode());
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - 要上传的文件的路径

parallelTransferOptions - ParallelTransferOptions 用于配置缓冲上传。

headers - PathHttpHeaders

metadata - 要与资源关联的元数据。如果任何元数据键或值中都有前导或尾随空格，则必须将其删除或编码。

requestConditions - DataLakeRequestConditions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

包含有关上传路径信息的响应。

uploadWithResponse

public Response uploadWithResponse(FileParallelUploadOptions options, Duration timeout, Context context)

创建新文件。若要避免覆盖，请将“*”传递给 setIfNoneMatch(String ifNoneMatch)。

示例代码

PathHttpHeaders headers = new PathHttpHeaders()
     .setContentMd5("data".getBytes(StandardCharsets.UTF_8))
     .setContentLanguage("en-US")
     .setContentType("binary");

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Long blockSize = 100L * 1024L * 1024L; // 100 MB;
 ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);

 try {
     client.uploadWithResponse(new FileParallelUploadOptions(data, length)
         .setParallelTransferOptions(parallelTransferOptions).setHeaders(headers)
         .setMetadata(metadata).setRequestConditions(requestConditions)
         .setPermissions("permissions").setUmask("umask"), timeout, new Context("key", "value"));
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

options - FileParallelUploadOptions

timeout - 一个可选的超时值，超过该值 RuntimeException 将引发。

context - 在服务调用期间通过 Http 管道传递的其他上下文。

Returns:

有关上传的路径的信息。

通过

DataLakeFileClient 类

方法摘要

方法继承自 DataLakePathClient

方法继承自 java.lang.Object

方法详细信息

append

append

appendWithResponse

appendWithResponse

appendWithResponse

appendWithResponse

delete

deleteIfExists

deleteIfExistsWithResponse

deleteWithResponse

flush

flush

flushWithResponse

flushWithResponse

getCustomerProvidedKeyClient

getFileName

getFilePath

getFileUrl

getOutputStream

getOutputStream

getOutputStream

openInputStream

openInputStream

openInputStream

openQueryInputStream

openQueryInputStreamWithResponse

query

queryWithResponse

read

readToFile

readToFile

readToFileWithResponse

readWithResponse

rename

renameWithResponse

scheduleDeletion

scheduleDeletionWithResponse

upload

upload

upload

upload

uploadFromFile

uploadFromFile

uploadFromFile

uploadFromFileWithResponse

uploadWithResponse

适用于

其他资源