DataLakeFileClient class

Referens

Paket:: @azure/storage-file-datalake

En DataLakeFileClient representerar en URL till Azure Storage-filen.

Extends: DataLakePathClient

Konstruktorer

DataLakeFileClient(string, Pipeline)	Skapar en instans av DataLakeFileClient från URL och pipeline.
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Skapar en instans av DataLakeFileClient från URL och autentiseringsuppgifter.

Egenskaper

fileSystemName	Namnet på det aktuella filsystemet.
name	Namn på aktuell sökväg (katalog eller fil).

Ärvda egenskaper

accountName
credential	Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från `@azure/identity`-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
url	Kodat URL-strängvärde.

Metoder

append(RequestBodyType, number, number, FileAppendOptions)	Laddar upp data som ska läggas till i en fil. Data kan bara läggas till i en fil. Om du vill använda perviously uppladdade data på en fil anropar du tömning. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
create(FileCreateOptions)	Skapa en fil. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	Skapa en fil. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(FileCreateIfNotExistsOptions)	Skapa en fil om den inte redan finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Skapa en fil om den inte redan finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
flush(number, FileFlushOptions)	Rensar (skriver) data som tidigare har bifogats till en fil.
generateSasStringToSign(FileGenerateSasUrlOptions)	Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter. Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter. Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)	Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)	Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
query(string, FileQueryOptions)	Snabbfråga för en JSON- eller CSV-formaterad fil. Exempel på användning (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)	Laddar ned en fil från tjänsten, inklusive dess metadata och egenskaper. I Node.jsreturnerar data i en läsbar dataström readableStreamBody I webbläsare returneras data i ett löftesinnehållAsBlob Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob Exempel på användning (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); }); } Exempel på användning (webbläsare): `// 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)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För filer som är större än den här storleken bör du överväga readToFile.
readToBuffer(number, number, FileReadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För filer som är större än den här storleken bör du överväga readToFile.
readToFile(string, number, number, FileReadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Data Lake-fil till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela filen.
setExpiry(FileExpiryMode, FileSetExpiryOptions)	Anger en förfallotid för en fil, när den tiden har uppnåtts tas filen bort.
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Laddar upp en buffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView till en fil.
uploadFile(string, FileParallelUploadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil till en Data Lake-fil.
uploadStream(Readable, FileParallelUploadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till en Data Lake-fil. Den här metoden försöker skapa en fil och börjar sedan ladda upp segment för segment. Kontrollera att den potentiella storleken på strömmen inte överskrider FILE_MAX_SIZE_BYTES och att det potentiella antalet segment inte överskrider BLOCK_BLOB_MAX_BLOCKS. TIPS FÖR PRESTANDAFÖRBÄTTRING: HighWaterMark för indataström är bättre att ange samma värde med parametern options.chunkSize, vilket undviker buffert.concat()-åtgärder.

Ärvda metoder

delete(boolean, PathDeleteOptions)	Ta bort aktuell sökväg (katalog eller fil). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Ta bort den aktuella sökvägen (katalog eller fil) om den finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Returnerar sant om Data Lake-filen som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom en befintlig fil kan tas bort av andra klienter eller program. Vice versa nya filer kan läggas till av andra klienter eller program när den här funktionen har slutförts.
getAccessControl(PathGetAccessControlOptions)	Returnerar åtkomstkontrolldata för en sökväg (filkatalog). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Hämta en DataLakeLeaseClient- som hanterar lån på sökvägen (katalog eller fil).
getProperties(PathGetPropertiesOptions)	Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för sökvägen (katalog eller fil). VARNING! Det `metadata` objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna för DataLakeFileSystemClient som listar sökvägar med hjälp av alternativet `includeMetadata`, som behåller sitt ursprungliga hölje. Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Flytta katalog eller fil i samma filsystem. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Flytta katalog eller fil till ett annat filsystem. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Tar bort åtkomstkontrollen på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Ange åtkomstkontrolldata för en sökväg (filkatalog). Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Anger åtkomstkontroll på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Anger systemegenskaper på sökvägen (katalog eller fil). Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Anger användardefinierade metadata för den angivna sökvägen (filkatalogen) som ett eller flera namn/värde-par. Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas sökvägens metadata bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Anger filbehörigheter för en sökväg. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog.
toFileClient()	Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Ändrar åtkomstkontrollen på en sökväg och undersökvägar. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Konstruktorinformation

DataLakeFileClient(string, Pipeline)

Skapar en instans av DataLakeFileClient från URL och pipeline.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parametrar

url: string

En klientsträng som pekar på En Azure Storage-datasjöfil, till exempel "https://myaccount.dfs.core.windows.net/filesystem/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".

pipeline: Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av DataLakeFileClient från URL och autentiseringsuppgifter.

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

Parametrar

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options: StoragePipelineOptions

Valfri. Alternativ för att konfigurera HTTP-pipelinen.

Egenskapsinformation

fileSystemName

Namnet på det aktuella filsystemet.

string fileSystemName

Egenskapsvärde

string

name

Namn på aktuell sökväg (katalog eller fil).

string name

Egenskapsvärde

string

Information om ärvda egenskaper

accountName

accountName: string

Egenskapsvärde

string

ärvd frånDataLakePathClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ärvd frånDataLakePathClient.credential

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

ärvd frånDataLakePathClient.url

Metodinformation

append(RequestBodyType, number, number, FileAppendOptions)

Laddar upp data som ska läggas till i en fil. Data kan bara läggas till i en fil. Om du vill använda perviously uppladdade data på en fil anropar du tömning.

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

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

Parametrar

body: HttpRequestBody

Innehåll som ska laddas upp.

offset: number

Tilläggsförskjutning i byte.

length: number

Längden på innehåll som ska läggas till i byte.

options: FileAppendOptions

Valfri. Alternativ när data ska läggas till.

Returer

Promise<FileAppendResponse>

create(FileCreateOptions)

Skapa en fil.

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

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

Parametrar

options: FileCreateOptions

Valfri. Alternativ när du skapar en fil.

Returer

Promise<FileCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Skapa en fil.

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

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

Parametrar

resourceType: PathResourceTypeModel

Resurstyp måste vara "fil" för DataLakeFileClient.

options: PathCreateOptions

Valfri. Alternativ när du skapar en fil.

Returer

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

Skapa en fil om den inte redan finns.

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

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

Parametrar

options: FileCreateIfNotExistsOptions

Valfri. Alternativ när du skapar en fil.

Returer

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Skapa en fil om den inte redan finns.

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

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

Parametrar

resourceType: PathResourceTypeModel

Resurstyp måste vara "fil" för DataLakeFileClient.

options: PathCreateIfNotExistsOptions

Returer

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

Rensar (skriver) data som tidigare har bifogats till en fil.

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

Parametrar

position: number

Filposition att tömma. Med den här parametern kan anroparen ladda upp data parallellt och styra i vilken ordning den läggs till i filen. Det krävs när du laddar upp data som ska läggas till i filen och vid tömning av tidigare uppladdade data till filen. Värdet måste vara den position där data ska läggas till. Uppladdade data rensas inte omedelbart, eller skrivs, till filen. För att rensa måste de tidigare uppladdade data vara sammanhängande, positionsparametern måste anges och vara lika med filens längd när alla data har skrivits och det får inte finnas en entitetstext för begäran som ingår i begäran.

options: FileFlushOptions

Valfri. Alternativ vid tömning av data.

Returer

Promise<FileFlushResponse>

generateSasStringToSign(FileGenerateSasUrlOptions)

Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter.

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateSasUrl(FileGenerateSasUrlOptions)

Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter.

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

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

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

Returer

Promise<string>

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

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

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

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

userDelegationKey: UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av indataanvändarens delegeringsnyckel.

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

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

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

userDelegationKey: UserDelegationKey

Returvärde för blobServiceClient.getUserDelegationKey()

Returer

Promise<string>

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

query(string, FileQueryOptions)

Snabbfråga för en JSON- eller CSV-formaterad fil.

Exempel på användning (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>

Parametrar

query: string

options: FileQueryOptions

Returer

Promise<FileReadResponse>

read(number, number, FileReadOptions)

Laddar ned en fil från tjänsten, inklusive dess metadata och egenskaper.

I Node.jsreturnerar data i en läsbar dataström readableStreamBody
I webbläsare returneras data i ett löftesinnehållAsBlob

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

Exempel på användning (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);
  });
}

Exempel på användning (webbläsare):

// 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>

Parametrar

offset: number

Valfri. Förskjutning till läsfil, standardvärdet är 0.

count: number

Valfri. Hur många byte som ska läsas kommer standard att läsas från förskjutning till slutet.

options: FileReadOptions

Valfri. Alternativ vid läsning av fil.

Returer

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen.

Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar i Node.js/V8. För filer som är större än den här storleken bör du överväga readToFile.

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

Parametrar

buffer: Buffer

Buffert som ska fyllas, måste ha en längd som är större än antalet

offset: number

Från vilken position Data Lake-filen ska läsas

count: number

Hur mycket data som ska läsas. Läse till slutet när odefinierat skickas

options: FileReadToBufferOptions

Returer

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME

Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen

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

Parametrar

offset: number

Från vilken position Data Lake-filen ska läsas (i byte)

count: number

Hur mycket data (i byte) som ska läsas. Läse till slutet när odefinierat skickas

options: FileReadToBufferOptions

Returer

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Laddar ned en Data Lake-fil till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela filen.

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

Parametrar

filePath: string

offset: number

Från vilken position filen ska laddas ned.

count: number

Hur mycket data som ska laddas ned. Laddas ned till slutet när odefinierade skickas.

options: FileReadOptions

Alternativ för att läsa Data Lake-filen.

Returer

Promise<FileReadResponse>

Svarsdata för filläsningsåtgärden, men med readableStreamBody inställt på odefinierat eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Anger en förfallotid för en fil, när den tiden har uppnåtts tas filen bort.

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

Parametrar

mode: FileExpiryMode

options: FileSetExpiryOptions

Returer

Promise<FileSetExpiryResponse>

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

Laddar upp en buffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView till en fil.

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

Parametrar

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer eller ArrayBufferView

options: FileParallelUploadOptions

Returer

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Laddar upp en lokal fil till en Data Lake-fil.

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

Parametrar

filePath: string

Fullständig sökväg till den lokala filen

options: FileParallelUploadOptions

Returer

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Laddar upp en Node.js läsbar dataström till en Data Lake-fil. Den här metoden försöker skapa en fil och börjar sedan ladda upp segment för segment. Kontrollera att den potentiella storleken på strömmen inte överskrider FILE_MAX_SIZE_BYTES och att det potentiella antalet segment inte överskrider BLOCK_BLOB_MAX_BLOCKS.

TIPS FÖR PRESTANDAFÖRBÄTTRING:

HighWaterMark för indataström är bättre att ange samma värde med parametern options.chunkSize, vilket undviker buffert.concat()-åtgärder.

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

Parametrar

stream: Readable

Node.js läsbar ström.

options: FileParallelUploadOptions

Returer

Promise<FileUploadResponse>

Ärvd metodinformation

delete(boolean, PathDeleteOptions)

Ta bort aktuell sökväg (katalog eller fil).

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

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

Parametrar

recursive: boolean

Krävs och är endast giltigt när resursen är en katalog. Om "sant" tas alla sökvägar under katalogen bort.

options: PathDeleteOptions

Valfri. Alternativ vid borttagning av sökväg.

Returer

Promise<PathDeleteResponse>

ärvd frånDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Ta bort den aktuella sökvägen (katalog eller fil) om den finns.

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

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

Parametrar

recursive: boolean

Krävs och är endast giltigt när resursen är en katalog. Om "sant" tas alla sökvägar under katalogen bort.

options: PathDeleteOptions

Returer

Promise<PathDeleteIfExistsResponse>

ärvd frånDataLakePathClient.deleteIfExists

exists(PathExistsOptions)

Returnerar sant om Data Lake-filen som representeras av den här klienten finns. annars falskt.

Obs! Använd den här funktionen med försiktighet eftersom en befintlig fil kan tas bort av andra klienter eller program. Vice versa nya filer kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

options: PathExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

ärvs frånDataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

Returnerar åtkomstkontrolldata för en sökväg (filkatalog).

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

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

Parametrar

options: PathGetAccessControlOptions

Valfri. Alternativ när du hämtar filåtkomstkontroll.

Returer

Promise<PathGetAccessControlResponse>

ärvd frånDataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Hämta en DataLakeLeaseClient- som hanterar lån på sökvägen (katalog eller fil).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametrar

proposeLeaseId: string

Valfri. Ursprungligt föreslaget låne-ID.

Returer

DataLakeLeaseClient

ärvd frånDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för sökvägen (katalog eller fil).

VARNING! Det metadata objekt som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av metoderna för DataLakeFileSystemClient som listar sökvägar med hjälp av alternativet includeMetadata, som behåller sitt ursprungliga hölje.

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

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

Parametrar

options: PathGetPropertiesOptions

Valfri. Alternativ när du hämtar sökvägsegenskaper.

Returer

Promise<PathGetPropertiesResponse>

ärvs frånDataLakePathClient.getProperties

move(string, PathMoveOptions)

Flytta katalog eller fil i samma filsystem.

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

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

Parametrar

destinationPath: string

Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil". Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".

options: PathMoveOptions

Valfri. Alternativ när du flyttar katalog eller fil.

Returer

Promise<PathMoveResponse>

ärvd frånDataLakePathClient.move

move(string, string, PathMoveOptions)

Flytta katalog eller fil till ett annat filsystem.

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

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

Parametrar

destinationFileSystem: string

Målfilsystem som "filsystem".

destinationPath: string

Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil" Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".

options: PathMoveOptions

Valfri. Alternativ när du flyttar katalog eller fil.

Returer

Promise<PathMoveResponse>

ärvd frånDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Tar bort åtkomstkontrollen på en sökväg och undersökvägar.

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

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

Parametrar

acl: RemovePathAccessControlItem[]

POSIX-åtkomstkontrollistan för filen eller katalogen.

options: PathChangeAccessControlRecursiveOptions

Valfri. Alternativ

Returer

Promise<PathChangeAccessControlRecursiveResponse>

ärvd frånDataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Ange åtkomstkontrolldata för en sökväg (filkatalog).

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

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

Parametrar

acl: PathAccessControlItem[]

POSIX-åtkomstkontrollistan för filen eller katalogen.

options: PathSetAccessControlOptions

Valfri. Alternativ när du anger åtkomstkontroll för sökväg.

Returer

Promise<PathSetAccessControlResponse>

ärvd frånDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Anger åtkomstkontroll på en sökväg och undersökvägar.

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

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

Parametrar

acl: PathAccessControlItem[]

POSIX-åtkomstkontrollistan för filen eller katalogen.

options: PathChangeAccessControlRecursiveOptions

Valfri. Alternativ

Returer

Promise<PathChangeAccessControlRecursiveResponse>

ärvd frånDataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Anger systemegenskaper på sökvägen (katalog eller fil).

Om inget värde anges, eller inget värde som angetts för de angivna HTTP-blobhuvudena, rensas dessa HTTP-blobhuvuden utan värde.

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

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

Parametrar

httpHeaders: PathHttpHeaders

options: PathSetHttpHeadersOptions

Returer

Promise<PathSetHttpHeadersResponse>

ärvd frånDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Anger användardefinierade metadata för den angivna sökvägen (filkatalogen) som ett eller flera namn/värde-par.

Om inget alternativ har angetts, eller om inga metadata har definierats i parametern, tas sökvägens metadata bort.

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

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

Parametrar

metadata: Metadata

Valfri. Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.

options: PathSetMetadataOptions

Valfri. Alternativ när du anger sökvägsmetadata.

Returer

Promise<PathSetMetadataResponse>

ärvd frånDataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Anger filbehörigheter för en sökväg.

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

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

Parametrar

permissions: PathPermissions

POSIX-åtkomstbehörigheterna för filägaren, filägargruppen och andra.

options: PathSetPermissionsOptions

Valfri. Alternativ när du anger sökvägsbehörigheter.

Returer

Promise<PathSetPermissionsResponse>

ärvd frånDataLakePathClient.setPermissions

toDirectoryClient()

Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog.

function toDirectoryClient(): DataLakeDirectoryClient

Returer

DataLakeDirectoryClient

ärvd frånDataLakePathClient.toDirectoryClient

toFileClient()

Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.

function toFileClient(): DataLakeFileClient

Returer

DataLakeFileClient

ärvd frånDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Ändrar åtkomstkontrollen på en sökväg och undersökvägar.

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

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

Parametrar

acl: PathAccessControlItem[]

POSIX-åtkomstkontrollistan för filen eller katalogen.

options: PathChangeAccessControlRecursiveOptions

Valfri. Alternativ

Returer

Promise<PathChangeAccessControlRecursiveResponse>

ärvd frånDataLakePathClient.updateAccessControlRecursive

Dela via

DataLakeFileClient class

Konstruktorer

Egenskaper

Ärvda egenskaper

Metoder

Ärvda metoder

Konstruktorinformation

DataLakeFileClient(string, Pipeline)

Parametrar

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

Parametrar

Egenskapsinformation

fileSystemName

Egenskapsvärde

name

Egenskapsvärde

Information om ärvda egenskaper

accountName

Egenskapsvärde

credential

Egenskapsvärde

url

Egenskapsvärde

Metodinformation

append(RequestBodyType, number, number, FileAppendOptions)

Parametrar

Returer

create(FileCreateOptions)

Parametrar

Returer

create(PathResourceTypeModel, PathCreateOptions)

Parametrar

Returer

createIfNotExists(FileCreateIfNotExistsOptions)

Parametrar

Returer

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Parametrar

Returer

flush(number, FileFlushOptions)

Parametrar

Returer

generateSasStringToSign(FileGenerateSasUrlOptions)

Parametrar

Returer

generateSasUrl(FileGenerateSasUrlOptions)

Parametrar

Returer

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Parametrar

Returer

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Parametrar

Returer

query(string, FileQueryOptions)

Parametrar

Returer

read(number, number, FileReadOptions)

Parametrar

Returer

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

Parametrar

Returer

readToBuffer(number, number, FileReadToBufferOptions)

Parametrar

Returer

readToFile(string, number, number, FileReadOptions)

Parametrar

Returer

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Parametrar

Returer

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

Parametrar

Returer

uploadFile(string, FileParallelUploadOptions)

Parametrar

Returer

uploadStream(Readable, FileParallelUploadOptions)