DataLakeFileClient class

Referentie

Pakket:: @azure/storage-file-datalake

Een DataLakeFileClient vertegenwoordigt een URL naar het Azure Storage-bestand.

Uitbreiding: DataLakePathClient

Constructors

DataLakeFileClient(string, Pipeline)	Hiermee maakt u een exemplaar van DataLakeFileClient op basis van url en pijplijn.
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Hiermee maakt u een exemplaar van DataLakeFileClient op basis van url en referentie.

Eigenschappen

fileSystemName	Naam van het huidige bestandssysteem.
name	Naam van het huidige pad (map of bestand).

Overgenomen eigenschappen

accountName
credential	Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het `@azure/identity`-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.
url	Gecodeerde URL-tekenreekswaarde.

Methoden

append(RequestBodyType, number, number, FileAppendOptions)	Hiermee worden gegevens geüpload die aan een bestand moeten worden toegevoegd. Gegevens kunnen alleen worden toegevoegd aan een bestand. Als u perviously geüploade gegevens wilt toepassen op een bestand, roept u flush aan. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
create(FileCreateOptions)	Maak een bestand. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	Maak een bestand. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(FileCreateIfNotExistsOptions)	Maak een bestand als dit nog niet bestaat. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Maak een bestand als dit nog niet bestaat. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
flush(number, FileFlushOptions)	Hiermee worden gegevens die eerder aan een bestand zijn toegevoegd (schrijfbewerkingen) leeggemaakt.
generateSasStringToSign(FileGenerateSasUrlOptions)	Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel. Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)	Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)	Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
query(string, FileQueryOptions)	Snelle query voor een bestand met JSON- of CSV-indeling. Voorbeeldgebruik (Node.js): // Query and convert a file to a string const queryResponse = await fileClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString(); console.log("Query file content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
read(number, number, FileReadOptions)	Hiermee downloadt u een bestand uit de service, inclusief de metagegevens en eigenschappen ervan. In Node.jsworden gegevens geretourneerd in een leesbare stream readableStreamBody In browsers worden gegevens geretourneerd in een promise contentAsBlob Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob Voorbeeldgebruik (Node.js): // Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await streamToBuffer(downloadResponse.readableStreamBody); console.log("Downloaded file content:", downloaded.toString()); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); } Voorbeeldgebruik (browser): `// Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await blobToString(await downloadResponse.contentAsBlob); console.log("Downloaded file content", downloaded); async function blobToString(blob: Blob): Promise<string> { const fileReader = new FileReader(); return new Promise<string>((resolve, reject) => { fileReader.onloadend = (ev: any) => { resolve(ev.target!.result); }; fileReader.onerror = reject; fileReader.readAsText(blob); }); }`
readToBuffer(Buffer, number, number, FileReadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Leest een Data Lake-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te lezen. Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen readToFile.
readToBuffer(number, number, FileReadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME Leest een Data Lake-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te lezen Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen readToFile.
readToFile(string, number, number, FileReadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Data Lake-bestand naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om het hele bestand te downloaden.
setExpiry(FileExpiryMode, FileSetExpiryOptions)	Hiermee stelt u een verlooptijd voor een bestand in, zodra aan het bestand is voldaan.
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Uploadt een buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView naar een bestand.
uploadFile(string, FileParallelUploadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Uploadt een lokaal bestand naar een Data Lake-bestand.
uploadStream(Readable, FileParallelUploadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee wordt een Node.js leesbare stroom geüpload naar een Data Lake-bestand. Met deze methode wordt geprobeerd een bestand te maken en vervolgens segment per segment te uploaden. Zorg ervoor dat de potentiële grootte van de stream niet groter is dan FILE_MAX_SIZE_BYTES en het potentiële aantal segmenten niet groter is dan BLOCK_BLOB_MAX_BLOCKS. TIPS VOOR PRESTATIEVERBETERING: Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter options.chunkSize, waardoor buffer.concat() bewerkingen worden voorkomen.

Overgenomen methoden

delete(boolean, PathDeleteOptions)	Verwijder het huidige pad (map of bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Verwijder het huidige pad (map of bestand) als dit bestaat. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Retourneert waar als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar. OPMERKING: gebruik deze functie met zorg omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
getAccessControl(PathGetAccessControlOptions)	Retourneert de toegangsbeheergegevens voor een pad (map van bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Haal een DataLakeLeaseClient- op waarmee leases op het pad (map of bestand) worden beheerd.
getProperties(PathGetPropertiesOptions)	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het pad (map of bestand). WAARSCHUWING: het `metadata` object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van DataLakeFileSystemClient die lijstpaden met behulp van de optie `includeMetadata`, die hun oorspronkelijke behuizing behouden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Map of bestand binnen hetzelfde bestandssysteem verplaatsen. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Map of bestand verplaatsen naar een ander bestandssysteem. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee verwijdert u het toegangsbeheer op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Stel de toegangsbeheergegevens in voor een pad (map van bestand). Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee stelt u het toegangsbeheer in op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Hiermee stelt u systeemeigenschappen in op het pad (map of bestand). Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van bestand) in als een of meer naam-waardeparen. Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van het pad verwijderd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Hiermee stelt u de bestandsmachtigingen voor een pad in. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Converteer huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is.
toFileClient()	Converteer huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Hiermee wijzigt u het toegangsbeheer op een pad en subpaden. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Constructordetails

DataLakeFileClient(string, Pipeline)

Hiermee maakt u een exemplaar van DataLakeFileClient op basis van url en pijplijn.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parameters

url: string

Een clienttekenreeks die verwijst naar een Azure Storage Data Lake-bestand, zoals 'https://myaccount.dfs.core.windows.net/filesystem/file". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".

pipeline: Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Hiermee maakt u een exemplaar van DataLakeFileClient op basis van url en referentie.

new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parameters

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options: StoragePipelineOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

fileSystemName

Naam van het huidige bestandssysteem.

string fileSystemName

Waarde van eigenschap

string

name

Naam van het huidige pad (map of bestand).

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName

accountName: string

Waarde van eigenschap

string

overgenomen vanDataLakePathClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

overgenomen vanDataLakePathClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen vanDataLakePathClient.url

Methodedetails

append(RequestBodyType, number, number, FileAppendOptions)

Hiermee worden gegevens geüpload die aan een bestand moeten worden toegevoegd. Gegevens kunnen alleen worden toegevoegd aan een bestand. Als u perviously geüploade gegevens wilt toepassen op een bestand, roept u flush aan.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

Parameters

body: HttpRequestBody

Inhoud die moet worden geüpload.

offset: number

Verschuiving toevoegen in bytes.

length: number

De lengte van de inhoud die moet worden toegevoegd in bytes.

options: FileAppendOptions

Facultatief. Opties bij het toevoegen van gegevens.

Retouren

Promise<FileAppendResponse>

create(FileCreateOptions)

Maak een bestand.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: FileCreateOptions): Promise<FileCreateResponse>

Parameters

options: FileCreateOptions

Facultatief. Opties bij het maken van een bestand.

Retouren

Promise<FileCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Maak een bestand.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

Parameters

resourceType: PathResourceTypeModel

Het resourcetype moet 'bestand' zijn voor DataLakeFileClient.

options: PathCreateOptions

Facultatief. Opties bij het maken van een bestand.

Retouren

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

Maak een bestand als dit nog niet bestaat.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>

Parameters

options: FileCreateIfNotExistsOptions

Facultatief. Opties bij het maken van een bestand.

Retouren

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Maak een bestand als dit nog niet bestaat.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Parameters

resourceType: PathResourceTypeModel

Het resourcetype moet 'bestand' zijn voor DataLakeFileClient.

options: PathCreateIfNotExistsOptions

Retouren

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

Hiermee worden gegevens die eerder aan een bestand zijn toegevoegd (schrijfbewerkingen) leeggemaakt.

function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

Parameters

position: number

De bestandspositie die moet worden leeggemaakt. Met deze parameter kan de aanroeper gegevens parallel uploaden en de volgorde bepalen waarin deze wordt toegevoegd aan het bestand. Het is vereist bij het uploaden van gegevens die moeten worden toegevoegd aan het bestand en bij het leegmaken van eerder geüploade gegevens naar het bestand. De waarde moet de positie zijn waar de gegevens moeten worden toegevoegd. Geüploade gegevens worden niet onmiddellijk leeggemaakt of naar het bestand geschreven. Als u wilt leegmaken, moeten de eerder geüploade gegevens aaneengesloten zijn, moet de positieparameter worden opgegeven en gelijk zijn aan de lengte van het bestand nadat alle gegevens zijn geschreven en mag er geen hoofdtekst van de aanvraag zijn opgenomen in de aanvraag.

options: FileFlushOptions

Facultatief. Opties bij het leegmaken van gegevens.

Retouren

Promise<FileFlushResponse>

generateSasStringToSign(FileGenerateSasUrlOptions)

Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel.

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

generateSasUrl(FileGenerateSasUrlOptions)

Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

userDelegationKey: UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

Promise<string>

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

query(string, FileQueryOptions)

Snelle query voor een bestand met JSON- of CSV-indeling.

Voorbeeldgebruik (Node.js):

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

Parameters

query: string

options: FileQueryOptions

Retouren

Promise<FileReadResponse>

read(number, number, FileReadOptions)

Hiermee downloadt u een bestand uit de service, inclusief de metagegevens en eigenschappen ervan.

In Node.jsworden gegevens geretourneerd in een leesbare stream readableStreamBody
In browsers worden gegevens geretourneerd in een promise contentAsBlob

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

Voorbeeldgebruik (Node.js):

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Voorbeeldgebruik (browser):

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

Parameters

offset: number

Facultatief. Verschuiving naar het leesbestand, de standaardwaarde is 0.

count: number

Facultatief. Hoeveel bytes er moeten worden gelezen, wordt standaard gelezen van offset naar het einde.

options: FileReadOptions

Facultatief. Opties bij het lezen van bestand.

Retouren

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Leest een Data Lake-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te lezen.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen readToFile.

function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

Parameters

buffer: Buffer

Buffer die moet worden gevuld, moet een lengte hebben die groter is dan het aantal

offset: number

Van waaruit de positie van het Data Lake-bestand moet worden gelezen

count: number

Hoeveel gegevens moeten worden gelezen. Wordt aan het einde gelezen wanneer niet-gedefinieerd wordt doorgegeven

options: FileReadToBufferOptions

Retouren

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME

Leest een Data Lake-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te lezen

function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

Parameters

offset: number

Vanaf welke positie van het Data Lake-bestand moet worden gelezen (in bytes)

count: number

Hoeveel gegevens (in bytes) moeten worden gelezen. Wordt aan het einde gelezen wanneer niet-gedefinieerd wordt doorgegeven

options: FileReadToBufferOptions

Retouren

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee downloadt u een Data Lake-bestand naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om het hele bestand te downloaden.

function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

Parameters

filePath: string

offset: number

Vanaf welke positie van het bestand moet worden gedownload.

count: number

Hoeveel gegevens moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven.

options: FileReadOptions

Opties voor het lezen van Het Data Lake-bestand.

Retouren

Promise<FileReadResponse>

De antwoordgegevens voor de leesbewerking van bestanden, maar met readableStreamBody is ingesteld op niet-gedefinieerd omdat de inhoud al is gelezen en naar een lokaal bestand op het opgegeven pad is geschreven.

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Hiermee stelt u een verlooptijd voor een bestand in, zodra aan het bestand is voldaan.

function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>

Parameters

mode: FileExpiryMode

options: FileSetExpiryOptions

Retouren

Promise<FileSetExpiryResponse>

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Uploadt een buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView naar een bestand.

function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parameters

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(knooppunt), Blob, ArrayBuffer of ArrayBufferView

options: FileParallelUploadOptions

Retouren

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Uploadt een lokaal bestand naar een Data Lake-bestand.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parameters

filePath: string

Volledig pad van het lokale bestand

options: FileParallelUploadOptions

Retouren

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee wordt een Node.js leesbare stroom geüpload naar een Data Lake-bestand. Met deze methode wordt geprobeerd een bestand te maken en vervolgens segment per segment te uploaden. Zorg ervoor dat de potentiële grootte van de stream niet groter is dan FILE_MAX_SIZE_BYTES en het potentiële aantal segmenten niet groter is dan BLOCK_BLOB_MAX_BLOCKS.

TIPS VOOR PRESTATIEVERBETERING:

Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter options.chunkSize, waardoor buffer.concat() bewerkingen worden voorkomen.

function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

Parameters

stream: Readable

Node.js leesbare stroom.

options: FileParallelUploadOptions

Retouren

Promise<FileUploadResponse>

Details overgenomen methode

delete(boolean, PathDeleteOptions)

Verwijder het huidige pad (map of bestand).

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Parameters

recursive: boolean

Alleen vereist en geldig als de resource een map is. Als 'waar' wordt, worden alle paden onder de map verwijderd.

options: PathDeleteOptions

Facultatief. Opties bij het verwijderen van het pad.

Retouren

Promise<PathDeleteResponse>

overgenomen vanDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Verwijder het huidige pad (map of bestand) als dit bestaat.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Parameters

recursive: boolean

Alleen vereist en geldig als de resource een map is. Als 'waar' wordt, worden alle paden onder de map verwijderd.

options: PathDeleteOptions

Retouren

Promise<PathDeleteIfExistsResponse>

overgenomen vanDataLakePathClient.deleteIfExists-

exists(PathExistsOptions)

Retourneert waar als het Data Lake-bestand dat wordt vertegenwoordigd door deze client bestaat; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

function exists(options?: PathExistsOptions): Promise<boolean>

Parameters

options: PathExistsOptions

opties voor bestaat bewerking.

Retouren

Promise<boolean>

overgenomen vanDataLakePathClient.bestaat

getAccessControl(PathGetAccessControlOptions)

Retourneert de toegangsbeheergegevens voor een pad (map van bestand).

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Parameters

options: PathGetAccessControlOptions

Facultatief. Opties bij het verkrijgen van toegangsbeheer voor bestanden.

Retouren

Promise<PathGetAccessControlResponse>

overgenomen vanDataLakePathClient.getAccessControl-

getDataLakeLeaseClient(string)

Haal een DataLakeLeaseClient- op waarmee leases op het pad (map of bestand) worden beheerd.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameters

proposeLeaseId: string

Facultatief. Oorspronkelijke voorgestelde lease-id.

Retouren

DataLakeLeaseClient

overgenomen vanDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard-HTTP-eigenschappen en systeemeigenschappen voor het pad (map of bestand).

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de methoden van DataLakeFileSystemClient die lijstpaden met behulp van de optie includeMetadata, die hun oorspronkelijke behuizing behouden.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Parameters

options: PathGetPropertiesOptions

Facultatief. Opties bij het ophalen van padeigenschappen.

Retouren

Promise<PathGetPropertiesResponse>

overgenomen vanDataLakePathClient.getProperties-

move(string, PathMoveOptions)

Map of bestand binnen hetzelfde bestandssysteem verplaatsen.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parameters

destinationPath: string

Pad naar doelmap, zoals map of bestandspad 'map/bestand'. Als het destinationPath is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals map/bestand?sasToken.

options: PathMoveOptions

Facultatief. Opties bij het verplaatsen van map of bestand.

Retouren

Promise<PathMoveResponse>

overgenomen vanDataLakePathClient.move

move(string, string, PathMoveOptions)

Map of bestand verplaatsen naar een ander bestandssysteem.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parameters

destinationFileSystem: string

Doelbestandssysteem zoals 'bestandssysteem'.

destinationPath: string

Pad naar de doelmap, zoals map of bestandspad 'map/bestand' Als het doelpad is geverifieerd met SAS, voegt u de SAS toe aan het doelpad, zoals 'map/bestand?sasToken'.

options: PathMoveOptions

Facultatief. Opties bij het verplaatsen van map of bestand.

Retouren

Promise<PathMoveResponse>

overgenomen vanDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee verwijdert u het toegangsbeheer op een pad en subpaden.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameters

acl: RemovePathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options: PathChangeAccessControlRecursiveOptions

Facultatief. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>

overgenomen vanDataLakePathClient.removeAccessControlRecursive-

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Stel de toegangsbeheergegevens in voor een pad (map van bestand).

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Parameters

acl: PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options: PathSetAccessControlOptions

Facultatief. Opties bij het instellen van toegangsbeheer voor paden.

Retouren

Promise<PathSetAccessControlResponse>

overgenomen vanDataLakePathClient.setAccessControl-

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee stelt u het toegangsbeheer in op een pad en subpaden.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameters

acl: PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options: PathChangeAccessControlRecursiveOptions

Facultatief. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>

overgenomen vanDataLakePathClient.setAccessControlRecursive-

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Hiermee stelt u systeemeigenschappen in op het pad (map of bestand).

Als er geen waarde is opgegeven of er geen waarde is opgegeven voor de opgegeven BLOB HTTP-headers, worden deze blob-HTTP-headers zonder waarde gewist.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Parameters

httpHeaders: PathHttpHeaders

options: PathSetHttpHeadersOptions

Retouren

Promise<PathSetHttpHeadersResponse>

overgenomen vanDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Hiermee stelt u door de gebruiker gedefinieerde metagegevens voor het opgegeven pad (map van bestand) in als een of meer naam-waardeparen.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van het pad verwijderd.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Parameters

metadata: Metadata

Facultatief. Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.

options: PathSetMetadataOptions

Facultatief. Opties bij het instellen van padmetagegevens.

Retouren

Promise<PathSetMetadataResponse>

overgenomen vanDataLakePathClient.setMetadata-

setPermissions(PathPermissions, PathSetPermissionsOptions)

Hiermee stelt u de bestandsmachtigingen voor een pad in.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Parameters

permissions: PathPermissions

De POSIX-toegangsmachtigingen voor de bestandseigenaar, de groep die eigenaar is van het bestand en andere.

options: PathSetPermissionsOptions

Facultatief. Opties bij het instellen van padmachtigingen.

Retouren

Promise<PathSetPermissionsResponse>

overgenomen vanDataLakePathClient.setPermissions

toDirectoryClient()

Converteer huidige DataLakePathClient naar DataLakeDirectoryClient als het huidige pad een map is.

function toDirectoryClient(): DataLakeDirectoryClient

Retouren

DataLakeDirectoryClient

overgenomen vanDataLakePathClient.toDirectoryClient

toFileClient()

Converteer huidige DataLakePathClient naar DataLakeFileClient als het huidige pad een bestand is.

function toFileClient(): DataLakeFileClient

Retouren

DataLakeFileClient

overgenomen vanDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Hiermee wijzigt u het toegangsbeheer op een pad en subpaden.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameters

acl: PathAccessControlItem[]

De POSIX-toegangsbeheerlijst voor het bestand of de map.

options: PathChangeAccessControlRecursiveOptions

Facultatief. Opties

Retouren

Promise<PathChangeAccessControlRecursiveResponse>

overgenomen vanDataLakePathClient.updateAccessControlRecursive-

Delen via

DataLakeFileClient class

Constructors

Eigenschappen

Overgenomen eigenschappen

Methoden

Overgenomen methoden

Constructordetails

DataLakeFileClient(string, Pipeline)

Parameters

DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parameters

Eigenschapdetails

fileSystemName

Waarde van eigenschap

name

Waarde van eigenschap

Details van overgenomen eigenschap

accountName

Waarde van eigenschap

credential

Waarde van eigenschap

url

Waarde van eigenschap

Methodedetails

append(RequestBodyType, number, number, FileAppendOptions)

Parameters

Retouren

create(FileCreateOptions)

Parameters

Retouren

create(PathResourceTypeModel, PathCreateOptions)

Parameters

Retouren

createIfNotExists(FileCreateIfNotExistsOptions)

Parameters

Retouren

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Parameters

Retouren

flush(number, FileFlushOptions)

Parameters

Retouren

generateSasStringToSign(FileGenerateSasUrlOptions)

Parameters

Retouren

generateSasUrl(FileGenerateSasUrlOptions)

Parameters

Retouren

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Parameters

Retouren

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Parameters

Retouren

query(string, FileQueryOptions)

Parameters

Retouren

read(number, number, FileReadOptions)

Parameters

Retouren

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

Parameters

Retouren

readToBuffer(number, number, FileReadToBufferOptions)

Parameters

Retouren

readToFile(string, number, number, FileReadOptions)

Parameters

Retouren

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Parameters

Retouren

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Parameters

Retouren

uploadFile(string, FileParallelUploadOptions)

Parameters

Retouren

uploadStream(Readable, FileParallelUploadOptions)