DataLakeFileClient class

Reference

Balíček:: @azure/storage-file-datalake

DataLakeFileClient představuje adresu URL souboru Azure Storage.

Extends: DataLakePathClient

Konstruktory

DataLakeFileClient(string, Pipeline)	Vytvoří instanci DataLakeFileClient z adresy URL a kanálu.
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Vytvoří instanci DataLakeFileClient z adresy URL a přihlašovacích údajů.

Vlastnosti

fileSystemName	Název aktuálního systému souborů.
name	Název aktuální cesty (adresář nebo soubor)

Zděděné vlastnosti

accountName
credential	Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z `@azure/identity` balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.
url	Zakódovaná hodnota řetězce adresy URL.

Metody

append(RequestBodyType, number, number, FileAppendOptions)	Nahraje data, která se mají připojit k souboru. Data lze připojit pouze k souboru. Pokud chcete na soubor použít zvěrně nahraná data, zavolejte vyprázdnění. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
create(FileCreateOptions)	Vytvořte soubor. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
create(PathResourceTypeModel, PathCreateOptions)	Vytvořte soubor. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
createIfNotExists(FileCreateIfNotExistsOptions)	Vytvořte soubor, pokud ještě neexistuje. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Vytvořte soubor, pokud ještě neexistuje. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
flush(number, FileFlushOptions)	Vyprázdní (zapíše) dříve připojená data do souboru.
generateSasUrl(FileGenerateSasUrlOptions)	K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
query(string, FileQueryOptions)	Rychlý dotaz na soubor ve formátu JSON nebo CSV Příklad použití (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)	Stáhne ze služby soubor, včetně jeho metadat a vlastností. V Node.js se data vrací v čitelném streamu readableStreamBody. V prohlížečích se data vrací v obsahu příslibuAsBlob. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob. Příklad použití (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); }); } Příklad použití (prohlížeč): `// 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)	K DISPOZICI POUZE V NODE.JS RUNTIME. Načte soubor Data Lake paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud chcete přečíst celý soubor, předejte 0. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat pouze soubory o velikosti přibližně jednoho gigabajtu v 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U souborů větších než tato velikost zvažte readToFile.
readToBuffer(number, number, FileReadToBufferOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME Načte soubor Data Lake paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud chcete přečíst celý soubor, předejte 0. Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat pouze soubory o velikosti přibližně jednoho gigabajtu v 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U souborů větších než tato velikost zvažte readToFile.
readToFile(string, number, number, FileReadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne soubor Data Lake do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pokud chcete stáhnout celý soubor, pass 0 a undefined v uvedeném pořadí.
setExpiry(FileExpiryMode, FileSetExpiryOptions)	Nastaví čas vypršení platnosti souboru, po uplynutí této doby se soubor odstraní.
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Nahraje buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView do souboru.
uploadFile(string, FileParallelUploadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje místní soubor do souboru Data Lake.
uploadStream(Readable, FileParallelUploadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Nahraje Node.js čitelný stream do souboru Data Lake. Tato metoda se pokusí vytvořit soubor a pak začne nahrávat bloky dat po bloku. Ujistěte se, že potenciální velikost streamu nepřekračuje FILE_MAX_SIZE_BYTES a že potenciální počet bloků dat nepřekračuje BLOCK_BLOB_MAX_BLOCKS. TIPY KE ZLEPŠENÍ VÝKONU: Vstupní stream highWaterMark je lepší nastavit stejnou hodnotu s parametrem options.chunkSize, který zabrání operacím Buffer.concat().

Zděděné metody

delete(boolean, PathDeleteOptions)	Odstranit aktuální cestu (adresář nebo soubor). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.
deleteIfExists(boolean, PathDeleteOptions)	Odstraňte aktuální cestu (adresář nebo soubor), pokud existuje. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.
exists(PathExistsOptions)	Vrátí hodnotu true, pokud existuje soubor Data Lake reprezentovaný tímto klientem; v opačném případě false. POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové soubory.
getAccessControl(PathGetAccessControlOptions)	Vrátí data řízení přístupu pro cestu (adresář souboru). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties.
getDataLakeLeaseClient(string)	Získejte DataLakeLeaseClient , který spravuje zapůjčení cesty (adresáře nebo souboru).
getProperties(PathGetPropertiesOptions)	Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti pro cestu (adresář nebo soubor). UPOZORNĚNÍ: Objekt `metadata` vrácený v odpovědi bude mít své klíče malými písmeny, i když původně obsahovaly velká písmena. To se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient , které vypisují cesty pomocí `includeMetadata` možnosti, která si zachová jejich původní velikost písmen. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.
move(string, PathMoveOptions)	Přesuňte adresář nebo soubor v rámci stejného systému souborů. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
move(string, string, PathMoveOptions)	Přesunout adresář nebo soubor do jiného systému souborů. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Odebere Access Control na cestě a dílčích cestách. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Nastavte data řízení přístupu pro cestu (adresář souboru). Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Nastaví Access Control na cestu a dílčí cesty. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Nastaví systémové vlastnosti v cestě (adresář nebo soubor). Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
setMetadata(Metadata, PathSetMetadataOptions)	Nastaví uživatelem definovaná metadata pro zadanou cestu (adresář souboru) jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata cesty se odeberou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
setPermissions(PathPermissions, PathSetPermissionsOptions)	Nastaví oprávnění k souboru v cestě. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
toDirectoryClient()	Pokud je aktuální cesta adresářem, převeďte aktuální DataLakePathClient na DataLakeDirectoryClient.
toFileClient()	Pokud je aktuální cesta souborem, převeďte aktuální DataLakePathClient na DataLakeFileClient.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Upraví Access Control na cestě a dílčích cestách. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

Podrobnosti konstruktoru

DataLakeFileClient(string, Pipeline)

Vytvoří instanci DataLakeFileClient z adresy URL a kanálu.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parametry

url: string

Řetězec klienta odkazující na soubor Azure Storage Data Lake, například "https://myaccount.dfs.core.windows.net/filesystem/file". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".

pipeline: Pipeline

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

Vytvoří instanci DataLakeFileClient z adresy URL a přihlašovacích údajů.

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověření požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadaný, použije se AnonymousCredential.

options: StoragePipelineOptions

Nepovinný parametr. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

fileSystemName

Název aktuálního systému souborů.

string fileSystemName

Hodnota vlastnosti

string

name

Název aktuální cesty (adresář nebo soubor)

string name

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName

accountName: string

Hodnota vlastnosti

string

Zděděno zDataLakePathClient.accountName

credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zděděno zDataLakePathClient.credential

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Zděděno zadresy DataLakePathClient.url

Podrobnosti metody

append(RequestBodyType, number, number, FileAppendOptions)

Nahraje data, která se mají připojit k souboru. Data lze připojit pouze k souboru. Pokud chcete na soubor použít zvěrně nahraná data, zavolejte vyprázdnění.

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

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

Parametry

body: HttpRequestBody

Obsah, který se má nahrát.

offset: number

Připojte posun v bajtech.

length: number

Délka obsahu, který se má připojit v bajtech.

options: FileAppendOptions

Nepovinný parametr. Možnosti při připojování dat

Návraty

Promise<FileAppendResponse>

create(FileCreateOptions)

Vytvořte soubor.

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

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

Parametry

options: FileCreateOptions

Nepovinný parametr. Možnosti při vytváření souboru

Návraty

Promise<FileCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Vytvořte soubor.

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

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

Parametry

resourceType: PathResourceTypeModel

Typ prostředku musí být "file" pro DataLakeFileClient.

options: PathCreateOptions

Nepovinný parametr. Možnosti při vytváření souboru

Návraty

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

Vytvořte soubor, pokud ještě neexistuje.

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

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

Parametry

options: FileCreateIfNotExistsOptions

Nepovinný parametr. Možnosti při vytváření souboru

Návraty

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Vytvořte soubor, pokud ještě neexistuje.

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

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

Parametry

resourceType: PathResourceTypeModel

Typ prostředku musí být "file" pro DataLakeFileClient.

options: PathCreateIfNotExistsOptions

Návraty

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

Vyprázdní (zapíše) dříve připojená data do souboru.

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

Parametry

position: number

Umístění souboru, který se má vyprázdnit. Tento parametr umožňuje volajícímu nahrávat data paralelně a řídit pořadí, ve kterém se připojují k souboru. Při nahrávání dat se vyžaduje připojení k souboru a při vyprázdnění dříve nahraných dat do souboru. Hodnota musí být pozice, na které se mají data připojit. Odeslaná data nejsou okamžitě vyprázdněna ani zapsána do souboru. Pro vyprázdnění musí být dříve nahraná data souvislá, musí být zadán parametr position a musí se rovnat délce souboru po zápisu všech dat a nesmí být součástí požadavku entita.

options: FileFlushOptions

Nepovinný parametr. Možnosti při vyprazdňování dat

Návraty

Promise<FileFlushResponse>

generateSasUrl(FileGenerateSasUrlOptions)

K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

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

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

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

Návraty

Promise<string>

Identifikátor URI SAS sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následného vygenerovaného tokenu SAS.

query(string, FileQueryOptions)

Rychlý dotaz na soubor ve formátu JSON nebo CSV

Příklad použití (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>

Parametry

query: string

options: FileQueryOptions

Návraty

Promise<FileReadResponse>

read(number, number, FileReadOptions)

Stáhne ze služby soubor, včetně jeho metadat a vlastností.

V Node.js se data vrací v čitelném streamu readableStreamBody.
V prohlížečích se data vrací v obsahu příslibuAsBlob.

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

Příklad použití (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);
  });
}

Příklad použití (prohlížeč):

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

Parametry

offset: number

Nepovinný parametr. Posun čtení souboru, výchozí hodnota je 0.

count: number

Nepovinný parametr. Kolik bajtů se má přečíst, výchozí hodnota se přečte od posunu do konce.

options: FileReadOptions

Nepovinný parametr. Možnosti při čtení souboru

Návraty

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Načte soubor Data Lake paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud chcete přečíst celý soubor, předejte 0.

Upozornění: Vyrovnávací paměti můžou kvůli omezením Node.js/V8 podporovat pouze soubory o velikosti přibližně jednoho gigabajtu v 32bitových systémech nebo přibližně dva gigabajty v 64bitových systémech. U souborů větších než tato velikost zvažte readToFile.

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

Parametry

buffer: Buffer

Vyrovnávací paměť, která se má vyplnit, musí mít délku větší než počet

offset: number

Z jaké pozice souboru Data Lake se má číst

count: number

Kolik dat se má přečíst. Bude číst až do konce, když předá nedefinované

options: FileReadToBufferOptions

Návraty

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME

Načte soubor Data Lake paralelně do vyrovnávací paměti. Posun a počet jsou volitelné. Pokud chcete přečíst celý soubor, předejte 0.

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

Parametry

offset: number

Z jaké pozice souboru Data Lake se má číst (v bajtech)

count: number

Kolik dat (v bajtech) se má přečíst. Bude číst až do konce, když předá nedefinované

options: FileReadToBufferOptions

Návraty

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne soubor Data Lake do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, pokud chcete stáhnout celý soubor, pass 0 a undefined v uvedeném pořadí.

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

Parametry

filePath: string

offset: number

Z jaké pozice souboru se má stáhnout.

count: number

Kolik dat se má stáhnout. Při předání nedefinovaného souboru se stáhne až do konce.

options: FileReadOptions

Možnosti čtení souboru Data Lake

Návraty

Promise<FileReadResponse>

Data odpovědi pro operaci čtení souboru, ale s funkcí readableStreamBody nastavenou na hodnotu undefined, protože její obsah je již přečten a zapsán do místního souboru v zadané cestě.

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Nastaví čas vypršení platnosti souboru, po uplynutí této doby se soubor odstraní.

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

Parametry

mode: FileExpiryMode

options: FileSetExpiryOptions

Návraty

Promise<FileSetExpiryResponse>

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

Nahraje buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView do souboru.

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

Parametry

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer nebo ArrayBufferView

options: FileParallelUploadOptions

Návraty

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Nahraje místní soubor do souboru Data Lake.

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

Parametry

filePath: string

Úplná cesta k místnímu souboru

options: FileParallelUploadOptions

Návraty

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME.

Nahraje Node.js čitelný stream do souboru Data Lake. Tato metoda se pokusí vytvořit soubor a pak začne nahrávat bloky dat po bloku. Ujistěte se, že potenciální velikost streamu nepřekračuje FILE_MAX_SIZE_BYTES a že potenciální počet bloků dat nepřekračuje BLOCK_BLOB_MAX_BLOCKS.

TIPY KE ZLEPŠENÍ VÝKONU:

Vstupní stream highWaterMark je lepší nastavit stejnou hodnotu s parametrem options.chunkSize, který zabrání operacím Buffer.concat().

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

Parametry

stream: Readable

Node.js čitelný datový proud.

options: FileParallelUploadOptions

Návraty

Promise<FileUploadResponse>

Podrobnosti zděděných metod

delete(boolean, PathDeleteOptions)

Odstranit aktuální cestu (adresář nebo soubor).

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

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

Parametry

recursive: boolean

Povinné a platné pouze v případě, že je prostředkem adresář. Pokud je "true", odstraní se všechny cesty pod adresářem.

options: PathDeleteOptions

Nepovinný parametr. Možnosti při odstraňování cesty

Návraty

Promise<PathDeleteResponse>

Zděděno zDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Odstraňte aktuální cestu (adresář nebo soubor), pokud existuje.

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

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

Parametry

recursive: boolean

Povinné a platné pouze v případě, že je prostředkem adresář. Pokud je "true", odstraní se všechny cesty pod adresářem.

options: PathDeleteOptions

Návraty

Promise<PathDeleteIfExistsResponse>

Zděděno zDataLakePathClient.deleteIfExists

exists(PathExistsOptions)

Vrátí hodnotu true, pokud existuje soubor Data Lake reprezentovaný tímto klientem; v opačném případě false.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Naopak po dokončení této funkce můžou další klienti nebo aplikace přidávat nové soubory.

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

Parametry

options: PathExistsOptions

možnosti operace Existuje.

Návraty

Promise<boolean>

Zděděno zDataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

Vrátí data řízení přístupu pro cestu (adresář souboru).

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

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

Parametry

options: PathGetAccessControlOptions

Nepovinný parametr. Možnosti při získávání řízení přístupu k souborům

Návraty

Promise<PathGetAccessControlResponse>

Zděděno zDataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Získejte DataLakeLeaseClient , který spravuje zapůjčení cesty (adresáře nebo souboru).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId: string

Nepovinný parametr. Počáteční navrhované ID zapůjčení

Návraty

DataLakeLeaseClient

Zděděno zDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti pro cestu (adresář nebo soubor).

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít své klíče malými písmeny, i když původně obsahovaly velká písmena. To se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient , které vypisují cesty pomocí includeMetadata možnosti, která si zachová jejich původní velikost písmen.

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

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

Parametry

options: PathGetPropertiesOptions

Nepovinný parametr. Možnosti při získávání vlastností cesty

Návraty

Promise<PathGetPropertiesResponse>

Zděděno zDataLakePathClient.getProperties

move(string, PathMoveOptions)

Přesuňte adresář nebo soubor v rámci stejného systému souborů.

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

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

Parametry

destinationPath: string

Cesta k cílovému adresáři, jako je "adresář" nebo cesta k souboru "adresář/soubor". Pokud je cesta destinationPath ověřená pomocí SAS, přidejte ho do cílové cesty jako "directory/file?sasToken".

options: PathMoveOptions

Nepovinný parametr. Možnosti při přesouvání adresáře nebo souboru

Návraty

Promise<PathMoveResponse>

Zděděno zDataLakePathClient.move

move(string, string, PathMoveOptions)

Přesunout adresář nebo soubor do jiného systému souborů.

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

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

Parametry

destinationFileSystem: string

Cílový systém souborů, například "systém souborů".

destinationPath: string

Cesta k cílovému adresáři, jako je "adresář" nebo cesta k souboru "adresář/soubor". Pokud je cílová cesta ověřená pomocí SAS, přidejte sas do cílové cesty jako adresář/soubor?sasToken.

options: PathMoveOptions

Nepovinný parametr. Možnosti při přesouvání adresáře nebo souboru

Návraty

Promise<PathMoveResponse>

Zděděno zDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Odebere Access Control na cestě a dílčích cestách.

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

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

Parametry

acl: RemovePathAccessControlItem[]

Seznam řízení přístupu POSIX pro soubor nebo adresář.

options: PathChangeAccessControlRecursiveOptions

Nepovinný parametr. Možnosti

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

Zděděno zDataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Nastavte data řízení přístupu pro cestu (adresář souboru).

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

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

Parametry

acl: PathAccessControlItem[]

Seznam řízení přístupu POSIX pro soubor nebo adresář.

options: PathSetAccessControlOptions

Nepovinný parametr. Možnosti při nastavení řízení přístupu k cestě

Návraty

Promise<PathSetAccessControlResponse>

Zděděno zDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Nastaví Access Control na cestu a dílčí cesty.

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

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

Parametry

acl: PathAccessControlItem[]

Seznam řízení přístupu POSIX pro soubor nebo adresář.

options: PathChangeAccessControlRecursiveOptions

Nepovinný parametr. Možnosti

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

Zděděno zDataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Nastaví systémové vlastnosti v cestě (adresář nebo soubor).

Pokud pro zadané hlavičky HTTP objektů blob není zadána žádná hodnota nebo žádná hodnota, budou tyto hlavičky HTTP objektů blob bez hodnoty vymazány.

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

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

Parametry

httpHeaders: PathHttpHeaders

options: PathSetHttpHeadersOptions

Návraty

Promise<PathSetHttpHeadersResponse>

Zděděno zDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Nastaví uživatelem definovaná metadata pro zadanou cestu (adresář souboru) jako jeden nebo více dvojic název-hodnota.

Pokud není k dispozici žádná možnost nebo nejsou v parametru definována žádná metadata, metadata cesty se odeberou.

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

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

Parametry

metadata: Metadata

Nepovinný parametr. Nahraďte existující metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata budou odebrána.

options: PathSetMetadataOptions

Nepovinný parametr. Možnosti při nastavování metadat cesty.

Návraty

Promise<PathSetMetadataResponse>

Zděděno zDataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Nastaví oprávnění k souboru v cestě.

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

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

Parametry

permissions: PathPermissions

Přístupová oprávnění POSIX pro vlastníka souboru, skupinu vlastníka souboru a další.

options: PathSetPermissionsOptions

Nepovinný parametr. Možnosti při nastavování oprávnění k cestě.

Návraty

Promise<PathSetPermissionsResponse>

Zděděno zDataLakePathClient.setPermissions

toDirectoryClient()

Pokud je aktuální cesta adresářem, převeďte aktuální DataLakePathClient na DataLakeDirectoryClient.

function toDirectoryClient(): DataLakeDirectoryClient

Návraty

DataLakeDirectoryClient

Zděděno zDataLakePathClient.toDirectoryClient

toFileClient()

Pokud je aktuální cesta souborem, převeďte aktuální DataLakePathClient na DataLakeFileClient.

function toFileClient(): DataLakeFileClient

Návraty

DataLakeFileClient

Zděděno zDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Upraví Access Control na cestě a dílčích cestách.

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

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

Parametry

acl: PathAccessControlItem[]

Seznam řízení přístupu POSIX pro soubor nebo adresář.

options: PathChangeAccessControlRecursiveOptions

Nepovinný parametr. Možnosti

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

Zděděno zDataLakePathClient.updateAccessControlRecursive

Sdílet prostřednictvím

DataLakeFileClient class

Konstruktory

Vlastnosti

Zděděné vlastnosti

Metody

Zděděné metody

Podrobnosti konstruktoru

DataLakeFileClient(string, Pipeline)

Parametry

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

Parametry

Podrobnosti vlastnosti

fileSystemName

Hodnota vlastnosti

name

Hodnota vlastnosti

Podrobnosti zděděných vlastností

accountName

Hodnota vlastnosti

credential

Hodnota vlastnosti

url

Hodnota vlastnosti

Podrobnosti metody

append(RequestBodyType, number, number, FileAppendOptions)

Parametry

Návraty

create(FileCreateOptions)

Parametry

Návraty

create(PathResourceTypeModel, PathCreateOptions)

Parametry

Návraty

createIfNotExists(FileCreateIfNotExistsOptions)

Parametry

Návraty

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Parametry

Návraty

flush(number, FileFlushOptions)

Parametry

Návraty

generateSasUrl(FileGenerateSasUrlOptions)

Parametry

Návraty

query(string, FileQueryOptions)

Parametry

Návraty

read(number, number, FileReadOptions)

Parametry

Návraty

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

Parametry

Návraty

readToBuffer(number, number, FileReadToBufferOptions)

Parametry

Návraty

readToFile(string, number, number, FileReadOptions)

Parametry

Návraty

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Parametry

Návraty

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

Parametry

Návraty

uploadFile(string, FileParallelUploadOptions)

Parametry

Návraty

uploadStream(Readable, FileParallelUploadOptions)

Parametry

Návraty

Podrobnosti zděděných metod

delete(boolean, PathDeleteOptions)

Parametry

Návraty

deleteIfExists(boolean, PathDeleteOptions)

Parametry

Návraty