@azure/storage-file-datalake 12.30.0 → 12.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -15
- package/dist/browser/clients.d.ts +36 -32
- package/dist/browser/clients.d.ts.map +1 -1
- package/dist/browser/clients.js +65 -31
- package/dist/browser/clients.js.map +1 -1
- package/dist/browser/generated/src/models/parameters.js +1 -1
- package/dist/browser/generated/src/models/parameters.js.map +1 -1
- package/dist/browser/generated/src/storageClient.js +2 -2
- package/dist/browser/generated/src/storageClient.js.map +1 -1
- package/dist/browser/models.d.ts +160 -1
- package/dist/browser/models.d.ts.map +1 -1
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/sas/DataLakeSASPermissions.d.ts +4 -0
- package/dist/browser/sas/DataLakeSASPermissions.d.ts.map +1 -1
- package/dist/browser/sas/DataLakeSASPermissions.js +10 -0
- package/dist/browser/sas/DataLakeSASPermissions.js.map +1 -1
- package/dist/browser/sas/FileSystemSASPermissions.d.ts +4 -0
- package/dist/browser/sas/FileSystemSASPermissions.d.ts.map +1 -1
- package/dist/browser/sas/FileSystemSASPermissions.js +10 -0
- package/dist/browser/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/browser/utils/constants.js +2 -2
- package/dist/browser/utils/constants.js.map +1 -1
- package/dist/browser/utils/utils.common.d.ts.map +1 -1
- package/dist/browser/utils/utils.common.js +14 -0
- package/dist/browser/utils/utils.common.js.map +1 -1
- package/dist/commonjs/clients.d.ts +36 -32
- package/dist/commonjs/clients.d.ts.map +1 -1
- package/dist/commonjs/clients.js +71 -31
- package/dist/commonjs/clients.js.map +2 -2
- package/dist/commonjs/generated/src/models/parameters.js +1 -1
- package/dist/commonjs/generated/src/models/parameters.js.map +1 -1
- package/dist/commonjs/generated/src/storageClient.js +2 -2
- package/dist/commonjs/generated/src/storageClient.js.map +1 -1
- package/dist/commonjs/models.d.ts +160 -1
- package/dist/commonjs/models.d.ts.map +1 -1
- package/dist/commonjs/models.js.map +2 -2
- package/dist/commonjs/sas/DataLakeSASPermissions.d.ts +4 -0
- package/dist/commonjs/sas/DataLakeSASPermissions.d.ts.map +1 -1
- package/dist/commonjs/sas/DataLakeSASPermissions.js +10 -0
- package/dist/commonjs/sas/DataLakeSASPermissions.js.map +2 -2
- package/dist/commonjs/sas/FileSystemSASPermissions.d.ts +4 -0
- package/dist/commonjs/sas/FileSystemSASPermissions.d.ts.map +1 -1
- package/dist/commonjs/sas/FileSystemSASPermissions.js +10 -0
- package/dist/commonjs/sas/FileSystemSASPermissions.js.map +2 -2
- package/dist/commonjs/tsdoc-metadata.json +1 -1
- package/dist/commonjs/utils/constants.js +2 -2
- package/dist/commonjs/utils/constants.js.map +1 -1
- package/dist/commonjs/utils/utils.common.d.ts.map +1 -1
- package/dist/commonjs/utils/utils.common.js +13 -0
- package/dist/commonjs/utils/utils.common.js.map +2 -2
- package/dist/esm/clients.d.ts +36 -32
- package/dist/esm/clients.d.ts.map +1 -1
- package/dist/esm/clients.js +65 -31
- package/dist/esm/clients.js.map +1 -1
- package/dist/esm/generated/src/models/parameters.js +1 -1
- package/dist/esm/generated/src/models/parameters.js.map +1 -1
- package/dist/esm/generated/src/storageClient.js +2 -2
- package/dist/esm/generated/src/storageClient.js.map +1 -1
- package/dist/esm/models.d.ts +160 -1
- package/dist/esm/models.d.ts.map +1 -1
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/sas/DataLakeSASPermissions.d.ts +4 -0
- package/dist/esm/sas/DataLakeSASPermissions.d.ts.map +1 -1
- package/dist/esm/sas/DataLakeSASPermissions.js +10 -0
- package/dist/esm/sas/DataLakeSASPermissions.js.map +1 -1
- package/dist/esm/sas/FileSystemSASPermissions.d.ts +4 -0
- package/dist/esm/sas/FileSystemSASPermissions.d.ts.map +1 -1
- package/dist/esm/sas/FileSystemSASPermissions.js +10 -0
- package/dist/esm/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/esm/utils/constants.js +2 -2
- package/dist/esm/utils/constants.js.map +1 -1
- package/dist/esm/utils/utils.common.d.ts.map +1 -1
- package/dist/esm/utils/utils.common.js +14 -0
- package/dist/esm/utils/utils.common.js.map +1 -1
- package/dist/react-native/clients.d.ts +36 -32
- package/dist/react-native/clients.d.ts.map +1 -1
- package/dist/react-native/clients.js +65 -31
- package/dist/react-native/clients.js.map +1 -1
- package/dist/react-native/generated/src/models/parameters.js +1 -1
- package/dist/react-native/generated/src/models/parameters.js.map +1 -1
- package/dist/react-native/generated/src/storageClient.js +2 -2
- package/dist/react-native/generated/src/storageClient.js.map +1 -1
- package/dist/react-native/models.d.ts +160 -1
- package/dist/react-native/models.d.ts.map +1 -1
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/sas/DataLakeSASPermissions.d.ts +4 -0
- package/dist/react-native/sas/DataLakeSASPermissions.d.ts.map +1 -1
- package/dist/react-native/sas/DataLakeSASPermissions.js +10 -0
- package/dist/react-native/sas/DataLakeSASPermissions.js.map +1 -1
- package/dist/react-native/sas/FileSystemSASPermissions.d.ts +4 -0
- package/dist/react-native/sas/FileSystemSASPermissions.d.ts.map +1 -1
- package/dist/react-native/sas/FileSystemSASPermissions.js +10 -0
- package/dist/react-native/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/react-native/utils/constants.js +2 -2
- package/dist/react-native/utils/constants.js.map +1 -1
- package/dist/react-native/utils/utils.common.d.ts.map +1 -1
- package/dist/react-native/utils/utils.common.js +14 -0
- package/dist/react-native/utils/utils.common.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -423,6 +423,7 @@ for await (const path of paths) {
|
|
|
423
423
|
```ts snippet:ReadmeSampleDownloadFile_Node
|
|
424
424
|
import { DataLakeServiceClient } from "@azure/storage-file-datalake";
|
|
425
425
|
import { DefaultAzureCredential } from "@azure/identity";
|
|
426
|
+
import { buffer } from "node:stream/consumers";
|
|
426
427
|
|
|
427
428
|
const account = "<account>";
|
|
428
429
|
const datalakeServiceClient = new DataLakeServiceClient(
|
|
@@ -439,23 +440,11 @@ const fileClient = fileSystemClient.getFileClient(fileName);
|
|
|
439
440
|
// In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
|
|
440
441
|
const downloadResponse = await fileClient.read();
|
|
441
442
|
if (downloadResponse.readableStreamBody) {
|
|
442
|
-
|
|
443
|
+
// Download the raw bytes of the file. Use `text` from "node:stream/consumers"
|
|
444
|
+
// instead if you want to read the content as a string directly.
|
|
445
|
+
const downloaded = await buffer(downloadResponse.readableStreamBody);
|
|
443
446
|
console.log("Downloaded file content:", downloaded.toString());
|
|
444
447
|
}
|
|
445
|
-
|
|
446
|
-
// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
|
|
447
|
-
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
|
|
448
|
-
return new Promise((resolve, reject) => {
|
|
449
|
-
const chunks: Buffer[] = [];
|
|
450
|
-
readableStream.on("data", (data) => {
|
|
451
|
-
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
|
|
452
|
-
});
|
|
453
|
-
readableStream.on("end", () => {
|
|
454
|
-
resolve(Buffer.concat(chunks));
|
|
455
|
-
});
|
|
456
|
-
readableStream.on("error", reject);
|
|
457
|
-
});
|
|
458
|
-
}
|
|
459
448
|
```
|
|
460
449
|
|
|
461
450
|
### Download a file and convert it to a string (Browsers)
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import type { TokenCredential } from "@azure/core-auth";
|
|
2
2
|
import type { RequestBodyType as HttpRequestBody } from "@azure/core-rest-pipeline";
|
|
3
3
|
import type { Pipeline } from "./Pipeline.js";
|
|
4
|
+
import { Tags } from "@azure/storage-blob";
|
|
4
5
|
import { AnonymousCredential } from "@azure/storage-common";
|
|
5
6
|
import { StorageSharedKeyCredential } from "./credentials/StorageSharedKeyCredential.js";
|
|
6
7
|
import type { Readable } from "node:stream";
|
|
7
8
|
import type { UserDelegationKey } from "@azure/storage-common";
|
|
8
9
|
import { DataLakeLeaseClient } from "./DataLakeLeaseClient.js";
|
|
9
|
-
import type { DataLakeClientConfig, DataLakeFileClientOptions, DataLakePathClientOptions, DirectoryCreateIfNotExistsOptions, DirectoryCreateIfNotExistsResponse, DirectoryCreateOptions, DirectoryCreateResponse, DirectoryGenerateSasUrlOptions, FileAppendOptions, FileAppendResponse, FileCreateIfNotExistsOptions, FileCreateIfNotExistsResponse, FileCreateOptions, FileCreateResponse, FileExpiryMode, FileFlushOptions, FileFlushResponse, FileGenerateSasUrlOptions, FileParallelUploadOptions, FileQueryOptions, FileReadOptions, FileReadResponse, FileReadToBufferOptions, FileSetExpiryOptions, FileSetExpiryResponse, FileUploadResponse, Metadata, PathAccessControlItem, PathChangeAccessControlRecursiveOptions, PathChangeAccessControlRecursiveResponse, PathCreateIfNotExistsOptions, PathCreateIfNotExistsResponse, PathCreateOptions, PathCreateResponse, PathDeleteIfExistsResponse, PathDeleteOptions, PathDeleteResponse, PathExistsOptions, PathGetAccessControlOptions, PathGetAccessControlResponse, PathGetPropertiesOptions, PathGetPropertiesResponse, PathHttpHeaders, PathMoveOptions, PathMoveResponse, PathPermissions, PathResourceTypeModel, PathSetAccessControlOptions, PathSetAccessControlResponse, PathSetHttpHeadersOptions, PathSetHttpHeadersResponse, PathSetMetadataOptions, PathSetMetadataResponse, PathSetPermissionsOptions, PathSetPermissionsResponse, RemovePathAccessControlItem } from "./models.js";
|
|
10
|
+
import type { DataLakeClientConfig, DataLakeFileClientOptions, DataLakePathClientOptions, DirectoryCreateIfNotExistsOptions, DirectoryCreateIfNotExistsResponse, DirectoryCreateOptions, DirectoryCreateResponse, DirectoryGenerateSasUrlOptions, FileAppendOptions, FileAppendResponse, FileCreateIfNotExistsOptions, FileCreateIfNotExistsResponse, FileCreateOptions, FileCreateResponse, FileExpiryMode, FileFlushOptions, FileFlushResponse, FileGenerateSasUrlOptions, FileParallelUploadOptions, FileQueryOptions, FileReadOptions, FileReadResponse, FileReadToBufferOptions, FileSetExpiryOptions, FileSetExpiryResponse, FileUploadResponse, Metadata, PathAccessControlItem, PathChangeAccessControlRecursiveOptions, PathChangeAccessControlRecursiveResponse, PathCreateIfNotExistsOptions, PathCreateIfNotExistsResponse, PathCreateOptions, PathCreateResponse, PathDeleteIfExistsResponse, PathDeleteOptions, PathDeleteResponse, PathExistsOptions, PathGetAccessControlOptions, PathGetAccessControlResponse, PathGetPropertiesOptions, PathGetPropertiesResponse, PathGetSystemPropertiesOptions, PathGetSystemPropertiesResponse, PathGetTagsOptions, PathGetTagsResponse, PathHttpHeaders, PathMoveOptions, PathMoveResponse, PathPermissions, PathResourceTypeModel, PathSetAccessControlOptions, PathSetAccessControlResponse, PathSetHttpHeadersOptions, PathSetHttpHeadersResponse, PathSetMetadataOptions, PathSetMetadataResponse, PathSetPermissionsOptions, PathSetPermissionsResponse, PathSetTagsOptions, PathSetTagsResponse, RemovePathAccessControlItem } from "./models.js";
|
|
10
11
|
import { StorageClient } from "./StorageClient.js";
|
|
11
12
|
/**
|
|
12
13
|
* A DataLakePathClient represents a URL to the Azure Storage path (directory or file).
|
|
@@ -178,6 +179,15 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
178
179
|
* @param options - Optional. Options when setting path permissions.
|
|
179
180
|
*/
|
|
180
181
|
setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>;
|
|
182
|
+
/**
|
|
183
|
+
* Returns all standard HTTP properties, and system properties
|
|
184
|
+
* for the path (directory or file).
|
|
185
|
+
*
|
|
186
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/get-properties?view=rest-storageservices-datalakestoragegen2-2019-12-12
|
|
187
|
+
*
|
|
188
|
+
* @param options - Optional. Options when getting path properties.
|
|
189
|
+
*/
|
|
190
|
+
getSystemProperties(options?: PathGetSystemPropertiesOptions): Promise<PathGetSystemPropertiesResponse>;
|
|
181
191
|
/**
|
|
182
192
|
* Returns all user-defined metadata, standard HTTP properties, and system properties
|
|
183
193
|
* for the path (directory or file).
|
|
@@ -216,6 +226,22 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
216
226
|
* @param options - Optional. Options when setting path metadata.
|
|
217
227
|
*/
|
|
218
228
|
setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>;
|
|
229
|
+
/**
|
|
230
|
+
* Gets the tags associated with the underlying path.
|
|
231
|
+
*
|
|
232
|
+
* @param options -
|
|
233
|
+
*/
|
|
234
|
+
getTags(options?: PathGetTagsOptions): Promise<PathGetTagsResponse>;
|
|
235
|
+
/**
|
|
236
|
+
* Sets tags on the underlying path.
|
|
237
|
+
* A path can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters.
|
|
238
|
+
* Valid tag key and value characters include lower and upper case letters, digits (0-9),
|
|
239
|
+
* space (' '), plus ('+'), minus ('-'), period ('.'), forward slash ('/'), colon (':'), equals ('='), and underscore ('_').
|
|
240
|
+
*
|
|
241
|
+
* @param tags -
|
|
242
|
+
* @param options -
|
|
243
|
+
*/
|
|
244
|
+
setTags(tags: Tags, options?: PathSetTagsOptions): Promise<PathSetTagsResponse>;
|
|
219
245
|
/**
|
|
220
246
|
* Move directory or file within same file system.
|
|
221
247
|
*
|
|
@@ -416,6 +442,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
416
442
|
* ```ts snippet:ReadmeSampleDownloadFile_Node
|
|
417
443
|
* import { DataLakeServiceClient } from "@azure/storage-file-datalake";
|
|
418
444
|
* import { DefaultAzureCredential } from "@azure/identity";
|
|
445
|
+
* import { buffer } from "node:stream/consumers";
|
|
419
446
|
*
|
|
420
447
|
* const account = "<account>";
|
|
421
448
|
* const datalakeServiceClient = new DataLakeServiceClient(
|
|
@@ -432,23 +459,11 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
432
459
|
* // In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
|
|
433
460
|
* const downloadResponse = await fileClient.read();
|
|
434
461
|
* if (downloadResponse.readableStreamBody) {
|
|
435
|
-
*
|
|
462
|
+
* // Download the raw bytes of the file. Use `text` from "node:stream/consumers"
|
|
463
|
+
* // instead if you want to read the content as a string directly.
|
|
464
|
+
* const downloaded = await buffer(downloadResponse.readableStreamBody);
|
|
436
465
|
* console.log("Downloaded file content:", downloaded.toString());
|
|
437
466
|
* }
|
|
438
|
-
*
|
|
439
|
-
* // [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
|
|
440
|
-
* async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
|
|
441
|
-
* return new Promise((resolve, reject) => {
|
|
442
|
-
* const chunks: Buffer[] = [];
|
|
443
|
-
* readableStream.on("data", (data) => {
|
|
444
|
-
* chunks.push(data instanceof Buffer ? data : Buffer.from(data));
|
|
445
|
-
* });
|
|
446
|
-
* readableStream.on("end", () => {
|
|
447
|
-
* resolve(Buffer.concat(chunks));
|
|
448
|
-
* });
|
|
449
|
-
* readableStream.on("error", reject);
|
|
450
|
-
* });
|
|
451
|
-
* }
|
|
452
467
|
* ```
|
|
453
468
|
*
|
|
454
469
|
* Example usage (browser):
|
|
@@ -595,6 +610,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
595
610
|
*
|
|
596
611
|
* ```ts snippet:ReadmeSampleQueryFile_Node
|
|
597
612
|
* import { DataLakeServiceClient } from "@azure/storage-file-datalake";
|
|
613
|
+
* import { buffer } from "node:stream/consumers";
|
|
598
614
|
*
|
|
599
615
|
* const account = "<account>";
|
|
600
616
|
* const sas = "<sas token>";
|
|
@@ -610,22 +626,10 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
610
626
|
* // Query and convert a file to a string
|
|
611
627
|
* const queryResponse = await fileClient.query("select * from BlobStorage");
|
|
612
628
|
* if (queryResponse.readableStreamBody) {
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
*
|
|
616
|
-
* }
|
|
617
|
-
*
|
|
618
|
-
* async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
|
|
619
|
-
* return new Promise((resolve, reject) => {
|
|
620
|
-
* const chunks: Buffer[] = [];
|
|
621
|
-
* readableStream.on("data", (data) => {
|
|
622
|
-
* chunks.push(data instanceof Buffer ? data : Buffer.from(data));
|
|
623
|
-
* });
|
|
624
|
-
* readableStream.on("end", () => {
|
|
625
|
-
* resolve(Buffer.concat(chunks));
|
|
626
|
-
* });
|
|
627
|
-
* readableStream.on("error", reject);
|
|
628
|
-
* });
|
|
629
|
+
* // Read the response bytes. Use `text` from "node:stream/consumers" instead
|
|
630
|
+
* // if you want the response as a string directly.
|
|
631
|
+
* const responseBuffer = await buffer(queryResponse.readableStreamBody);
|
|
632
|
+
* console.log(`Query file content: ${responseBuffer.toString()}`);
|
|
629
633
|
* }
|
|
630
634
|
* ```
|
|
631
635
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/clients.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,KAAK,EAAE,eAAe,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"clients.d.ts","sourceRoot":"","sources":["../../src/clients.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,KAAK,EAAE,eAAe,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,EAA+B,IAAI,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAC;AACzF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,KAAK,EAEV,oBAAoB,EACpB,yBAAyB,EACzB,yBAAyB,EACzB,iCAAiC,EACjC,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EAC9B,iBAAiB,EACjB,kBAAkB,EAClB,4BAA4B,EAC5B,6BAA6B,EAC7B,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,yBAAyB,EACzB,yBAAyB,EACzB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,QAAQ,EACR,qBAAqB,EACrB,uCAAuC,EACvC,wCAAwC,EACxC,4BAA4B,EAC5B,6BAA6B,EAC7B,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,2BAA2B,EAC3B,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,+BAA+B,EAC/B,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,4BAA4B,EAC5B,yBAAyB,EACzB,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,2BAA2B,EAC5B,MAAM,aAAa,CAAC;AAMrB,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AA8CnD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD;;OAEG;IACH,OAAO,CAAC,WAAW,CAAO;IAE1B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAa;IAE/B,OAAO,CAAC,iBAAiB,CAAC,CAAU;IAEpC;;;;;;;;OAQG;YACW,iCAAiC;IA4E/C;;;;;;;;OAQG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAG/E,OAAO,CAAC,EAAE,yBAAyB;IAGrC;;;;;;;;OAQG;gBACgB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,oBAAoB;IA+BlF;;;;OAIG;IACH,IAAW,cAAc,IAAI,MAAM,CAElC;IAED;;;;OAIG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IAGI,iBAAiB,IAAI,uBAAuB;IAQnD;;;OAGG;IAGI,YAAY,IAAI,kBAAkB;IAIzC;;;;OAIG;IACI,sBAAsB,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,mBAAmB;IAI3E;;;;;;;OAOG;IACU,MAAM,CACjB,YAAY,EAAE,qBAAqB,EACnC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAgC9B;;;;;;;OAOG;IACU,iBAAiB,CAC5B,YAAY,EAAE,qBAAqB,EACnC,OAAO,GAAE,4BAAiC,GACzC,OAAO,CAAC,6BAA6B,CAAC;IA8BzC;;;;;;;;OAQG;IACU,MAAM,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAStE;;;;;;;OAOG;IACU,MAAM,CACjB,SAAS,CAAC,EAAE,OAAO,EACnB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAuC9B;;;;;;;OAOG;IACU,cAAc,CACzB,SAAS,CAAC,EAAE,OAAO,EACnB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IA0BtC;;;;;;OAMG;IACU,gBAAgB,CAC3B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IA0BxC;;;;;;;OAOG;IACU,gBAAgB,CAC3B,GAAG,EAAE,qBAAqB,EAAE,EAC5B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IAkBxC;;;;;;;OAOG;IACU,yBAAyB,CACpC,GAAG,EAAE,qBAAqB,EAAE,EAC5B,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;OAOG;IACU,4BAA4B,CACvC,GAAG,EAAE,qBAAqB,EAAE,EAC5B,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;OAOG;IACU,4BAA4B,CACvC,GAAG,EAAE,2BAA2B,EAAE,EAClC,OAAO,GAAE,uCAA4C,GACpD,OAAO,CAAC,wCAAwC,CAAC;IAUpD;;;;;;;OAOG;IACU,cAAc,CACzB,WAAW,EAAE,eAAe,EAC5B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAkBtC;;;;;;;OAOG;IACU,mBAAmB,CAC9B,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,+BAA+B,CAAC;IA4B3C;;;;;;;;;;;;OAYG;IACU,aAAa,CACxB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,yBAAyB,CAAC;IAerC;;;;;;;;;OASG;IACU,cAAc,CACzB,WAAW,EAAE,eAAe,EAC5B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAoBtC;;;;;;;;;;;OAWG;IACU,WAAW,CACtB,QAAQ,CAAC,EAAE,QAAQ,EACnB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,uBAAuB,CAAC;IAcnC;;;;OAIG;IACU,OAAO,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQpF;;;;;;;;OAQG;IACU,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAShG;;;;;;;;OAQG;IACU,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAEhG;;;;;;;;;OASG;IACU,IAAI,CACf,qBAAqB,EAAE,MAAM,EAC7B,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,gBAAgB,CAAC;CA4D7B;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAE7D;;;;;;;OAOG;IACU,MAAM,CACjB,YAAY,EAAE,qBAAqB,EACnC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAE9B;;;;;;OAMG;IACU,MAAM,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IA4BvF;;;;;;;OAOG;IACU,iBAAiB,CAC5B,YAAY,EAAE,qBAAqB,EACnC,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,6BAA6B,CAAC;IAEzC;;;;;;OAMG;IACU,iBAAiB,CAC5B,OAAO,CAAC,EAAE,iCAAiC,GAC1C,OAAO,CAAC,kCAAkC,CAAC;IA2B9C;;;;OAIG;IACI,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,GAAG,uBAAuB;IAO/E;;;;OAIG;IAGI,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB;IAO1D;;;;;;;;;;OAUG;IACI,cAAc,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,MAAM,CAAC;IAsB/E;;;;;;;;OAQG;IAEI,uBAAuB,CAAC,OAAO,EAAE,8BAA8B,GAAG,MAAM;IAiB/E;;;;;;;;;OASG;IACI,4BAA4B,CACjC,OAAO,EAAE,8BAA8B,EACvC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;OASG;IAEI,qCAAqC,CAC1C,OAAO,EAAE,8BAA8B,EACvC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM;CAYV;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,kBAAkB;IACxD;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAO;IAElC;;OAEG;IACH,OAAO,CAAC,iCAAiC,CAAO;IAEhD;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAAkB;IAEjD;;;;;;;;OAQG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAG/E,OAAO,CAAC,EAAE,yBAAyB;IAGrC;;;;;;;;OAQG;gBACgB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,oBAAoB;IAmClF;;;;;;;OAOG;IACU,MAAM,CACjB,YAAY,EAAE,qBAAqB,EACnC,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAE9B;;;;;;OAMG;IACU,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA4B7E;;;;;;;OAOG;IACU,iBAAiB,CAC5B,YAAY,EAAE,qBAAqB,EACnC,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,6BAA6B,CAAC;IAEzC;;;;;;OAMG;IACU,iBAAiB,CAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,6BAA6B,CAAC;IAyBzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACU,IAAI,CACf,MAAM,GAAE,MAAU,EAClB,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAwB5B;;;;;;;;;;OAUG;IACU,MAAM,CACjB,IAAI,EAAE,eAAe,EACrB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAgC9B;;;;;;;;;;;OAWG;IACU,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBhG;;;;;;;OAOG;IACU,UAAU,CACrB,QAAQ,EAAE,MAAM,EAGhB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,kBAAkB,CAAC;IAsB9B;;;;;OAKG;IACU,MAAM,CACjB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,WAAW,GAAG,eAAe,EACnD,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,kBAAkB,CAAC;YA6BhB,sBAAsB;IAmIpC;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,MAAM,EAAE,QAAQ,EAChB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,kBAAkB,CAAC;IA4E9B;;;;;;;;;;;;;;OAcG;IACU,YAAY,CACvB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,MAAM,CAAC;IAElB;;;;;;;;;;;;;OAaG;IACU,YAAY,CACvB,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,MAAM,CAAC;IAgDlB;;;;;;;;;;;;;;;OAeG;IACU,UAAU,CACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,MAAU,EAClB,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAuB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmB5F;;;;;OAKG;IACU,SAAS,CACpB,IAAI,EAAE,cAAc,EACpB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,qBAAqB,CAAC;IAsCjC;;;;;;;;;;OAUG;IACI,cAAc,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC;IAqB1E;;;;;;;;;;OAUG;IAEI,uBAAuB,CAAC,OAAO,EAAE,yBAAyB,GAAG,MAAM;IAiB1E;;;;;;;;;OASG;IACI,4BAA4B,CACjC,OAAO,EAAE,yBAAyB,EAClC,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;OASG;IAEI,qCAAqC,CAC1C,OAAO,EAAE,yBAAyB,EAClC,iBAAiB,EAAE,iBAAiB,GACnC,MAAM;CAWV"}
|
package/dist/browser/clients.js
CHANGED
|
@@ -426,6 +426,32 @@ export class DataLakePathClient extends StorageClient {
|
|
|
426
426
|
}));
|
|
427
427
|
});
|
|
428
428
|
}
|
|
429
|
+
/**
|
|
430
|
+
* Returns all standard HTTP properties, and system properties
|
|
431
|
+
* for the path (directory or file).
|
|
432
|
+
*
|
|
433
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/get-properties?view=rest-storageservices-datalakestoragegen2-2019-12-12
|
|
434
|
+
*
|
|
435
|
+
* @param options - Optional. Options when getting path properties.
|
|
436
|
+
*/
|
|
437
|
+
async getSystemProperties(options = {}) {
|
|
438
|
+
return tracingClient.withSpan("DataLakePathClient-getSystemProperties", options, async (updatedOptions) => {
|
|
439
|
+
const response = assertResponse(await this.pathContext.getProperties({
|
|
440
|
+
...updatedOptions,
|
|
441
|
+
action: "getStatus",
|
|
442
|
+
upn: options.userPrincipalName,
|
|
443
|
+
leaseAccessConditions: options.conditions,
|
|
444
|
+
modifiedAccessConditions: options.conditions,
|
|
445
|
+
abortSignal: options.abortSignal,
|
|
446
|
+
}));
|
|
447
|
+
return {
|
|
448
|
+
...response,
|
|
449
|
+
_response: response._response,
|
|
450
|
+
isDirectory: response.resourceType === "directory",
|
|
451
|
+
permissions: toPermissions(response.permissions),
|
|
452
|
+
};
|
|
453
|
+
});
|
|
454
|
+
}
|
|
429
455
|
/**
|
|
430
456
|
* Returns all user-defined metadata, standard HTTP properties, and system properties
|
|
431
457
|
* for the path (directory or file).
|
|
@@ -492,6 +518,36 @@ export class DataLakePathClient extends StorageClient {
|
|
|
492
518
|
});
|
|
493
519
|
});
|
|
494
520
|
}
|
|
521
|
+
/**
|
|
522
|
+
* Gets the tags associated with the underlying path.
|
|
523
|
+
*
|
|
524
|
+
* @param options -
|
|
525
|
+
*/
|
|
526
|
+
async getTags(options = {}) {
|
|
527
|
+
return tracingClient.withSpan("DataLakePathClient-getTags", options, async (updatedOptions) => {
|
|
528
|
+
return this.blobClient.getTags({
|
|
529
|
+
...options,
|
|
530
|
+
tracingOptions: updatedOptions.tracingOptions,
|
|
531
|
+
});
|
|
532
|
+
});
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* Sets tags on the underlying path.
|
|
536
|
+
* A path can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters.
|
|
537
|
+
* Valid tag key and value characters include lower and upper case letters, digits (0-9),
|
|
538
|
+
* space (' '), plus ('+'), minus ('-'), period ('.'), forward slash ('/'), colon (':'), equals ('='), and underscore ('_').
|
|
539
|
+
*
|
|
540
|
+
* @param tags -
|
|
541
|
+
* @param options -
|
|
542
|
+
*/
|
|
543
|
+
async setTags(tags, options = {}) {
|
|
544
|
+
return tracingClient.withSpan("DataLakePathClient-setTags", options, async (updatedOptions) => {
|
|
545
|
+
return this.blobClient.setTags(tags, {
|
|
546
|
+
...options,
|
|
547
|
+
tracingOptions: updatedOptions.tracingOptions,
|
|
548
|
+
});
|
|
549
|
+
});
|
|
550
|
+
}
|
|
495
551
|
async move(destinationPathOrFileSystem, destinationPathOrOptions, options) {
|
|
496
552
|
let destinationFileSystem = this.fileSystemName;
|
|
497
553
|
let destinationPath = destinationPathOrFileSystem;
|
|
@@ -755,6 +811,7 @@ export class DataLakeFileClient extends DataLakePathClient {
|
|
|
755
811
|
* ```ts snippet:ReadmeSampleDownloadFile_Node
|
|
756
812
|
* import { DataLakeServiceClient } from "@azure/storage-file-datalake";
|
|
757
813
|
* import { DefaultAzureCredential } from "@azure/identity";
|
|
814
|
+
* import { buffer } from "node:stream/consumers";
|
|
758
815
|
*
|
|
759
816
|
* const account = "<account>";
|
|
760
817
|
* const datalakeServiceClient = new DataLakeServiceClient(
|
|
@@ -771,23 +828,11 @@ export class DataLakeFileClient extends DataLakePathClient {
|
|
|
771
828
|
* // In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
|
|
772
829
|
* const downloadResponse = await fileClient.read();
|
|
773
830
|
* if (downloadResponse.readableStreamBody) {
|
|
774
|
-
*
|
|
831
|
+
* // Download the raw bytes of the file. Use `text` from "node:stream/consumers"
|
|
832
|
+
* // instead if you want to read the content as a string directly.
|
|
833
|
+
* const downloaded = await buffer(downloadResponse.readableStreamBody);
|
|
775
834
|
* console.log("Downloaded file content:", downloaded.toString());
|
|
776
835
|
* }
|
|
777
|
-
*
|
|
778
|
-
* // [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
|
|
779
|
-
* async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
|
|
780
|
-
* return new Promise((resolve, reject) => {
|
|
781
|
-
* const chunks: Buffer[] = [];
|
|
782
|
-
* readableStream.on("data", (data) => {
|
|
783
|
-
* chunks.push(data instanceof Buffer ? data : Buffer.from(data));
|
|
784
|
-
* });
|
|
785
|
-
* readableStream.on("end", () => {
|
|
786
|
-
* resolve(Buffer.concat(chunks));
|
|
787
|
-
* });
|
|
788
|
-
* readableStream.on("error", reject);
|
|
789
|
-
* });
|
|
790
|
-
* }
|
|
791
836
|
* ```
|
|
792
837
|
*
|
|
793
838
|
* Example usage (browser):
|
|
@@ -1202,6 +1247,7 @@ export class DataLakeFileClient extends DataLakePathClient {
|
|
|
1202
1247
|
*
|
|
1203
1248
|
* ```ts snippet:ReadmeSampleQueryFile_Node
|
|
1204
1249
|
* import { DataLakeServiceClient } from "@azure/storage-file-datalake";
|
|
1250
|
+
* import { buffer } from "node:stream/consumers";
|
|
1205
1251
|
*
|
|
1206
1252
|
* const account = "<account>";
|
|
1207
1253
|
* const sas = "<sas token>";
|
|
@@ -1217,22 +1263,10 @@ export class DataLakeFileClient extends DataLakePathClient {
|
|
|
1217
1263
|
* // Query and convert a file to a string
|
|
1218
1264
|
* const queryResponse = await fileClient.query("select * from BlobStorage");
|
|
1219
1265
|
* if (queryResponse.readableStreamBody) {
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1222
|
-
*
|
|
1223
|
-
* }
|
|
1224
|
-
*
|
|
1225
|
-
* async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
|
|
1226
|
-
* return new Promise((resolve, reject) => {
|
|
1227
|
-
* const chunks: Buffer[] = [];
|
|
1228
|
-
* readableStream.on("data", (data) => {
|
|
1229
|
-
* chunks.push(data instanceof Buffer ? data : Buffer.from(data));
|
|
1230
|
-
* });
|
|
1231
|
-
* readableStream.on("end", () => {
|
|
1232
|
-
* resolve(Buffer.concat(chunks));
|
|
1233
|
-
* });
|
|
1234
|
-
* readableStream.on("error", reject);
|
|
1235
|
-
* });
|
|
1266
|
+
* // Read the response bytes. Use `text` from "node:stream/consumers" instead
|
|
1267
|
+
* // if you want the response as a string directly.
|
|
1268
|
+
* const responseBuffer = await buffer(queryResponse.readableStreamBody);
|
|
1269
|
+
* console.log(`Query file content: ${responseBuffer.toString()}`);
|
|
1236
1270
|
* }
|
|
1237
1271
|
* ```
|
|
1238
1272
|
*
|