DataLakeFileClient class

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

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parameters

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

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

Parameters

Naam van het huidige bestandssysteem.

string fileSystemName

Waarde van eigenschap

Naam van het huidige pad (map of bestand).

string name

Waarde van eigenschap

accountName: string

Waarde van eigenschap

Overgeërfd vanDataLakePathClient.accountName

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

Overgeërfd vanDataLakePathClient.credential

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

Overgeërfd vanDataLakePathClient.url

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://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Maak een bestand.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

Maak een bestand.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

Maak een bestand als dit nog niet bestaat.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

Maak een bestand als dit nog niet bestaat.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

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

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

Parameters

Retouren

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://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parameters

Retouren

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

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://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

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

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://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

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

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://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

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

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

Voorbeeldgebruik (Node.js):

import { DataLakeServiceClient } from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

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

async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    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

Retouren

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://free.blessedness.top/rest/api/storageservices/get-blob

• Voorbeeldgebruik (Node.js):

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadResponse.readableStreamBody
const downloadResponse = await fileClient.read();
if (downloadResponse.readableStreamBody) {
  const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
  console.log("Downloaded file content:", downloaded.toString());
}

// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer.
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    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):

import { DataLakeServiceClient } from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const fileName = "<file name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);
const fileClient = fileSystemClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadResponse.contentAsBlob
const downloadResponse = await fileClient.read();
if (downloadResponse.contentAsBlob) {
  const blob = await downloadResponse.contentAsBlob;
  const downloaded = await blob.text();
  console.log(`Downloaded file content ${downloaded}`);
}

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

Parameters

Retouren

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

Retouren

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(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

Parameters

Retouren

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

Retouren

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.

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

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

Parameters

Retouren

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

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

Parameters

Retouren

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Uploadt een lokaal bestand naar een Data Lake-bestand.

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

Parameters

Retouren

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

Retouren

Verwijder het huidige pad (map of bestand).

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.delete

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

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.deleteIfExists

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

Retouren

Overgeërfd vanDataLakePathClient.exists

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

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.getAccessControl

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameters

Retouren

Overgeërfd vanDataLakePathClient.getDataLakeLeaseClient

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://free.blessedness.top/rest/api/storageservices/get-blob-properties

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.getProperties

Map of bestand binnen hetzelfde bestandssysteem verplaatsen.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.move

Map of bestand verplaatsen naar een ander bestandssysteem.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.move

Hiermee verwijdert u het toegangsbeheer op een pad en subpaden.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.removeAccessControlRecursive

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

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.setAccessControl

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

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.setAccessControlRecursive

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://free.blessedness.top/rest/api/storageservices/set-blob-properties

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.setHttpHeaders

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://free.blessedness.top/rest/api/storageservices/set-blob-metadata

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.setMetadata

Hiermee stelt u de bestandsmachtigingen voor een pad in.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Overgenomen vanDataLakePathClient.setPermissions

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

function toDirectoryClient(): DataLakeDirectoryClient

Retouren

Overgeërfd vanDataLakePathClient.toDirectoryClient

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

function toFileClient(): DataLakeFileClient

Retouren

Overgeërfd vanDataLakePathClient.toFileClient

Hiermee wijzigt u het toegangsbeheer op een pad en subpaden.

Zie https://free.blessedness.top/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameters

Retouren

Overgeërfd vanDataLakePathClient.updateAccessControlRecursive