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 balíčku `@azure/identity` k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. 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 trvale nahraná data, volání 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)	Pokud soubor ještě neexistuje, vytvořte ho. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Pokud soubor ještě neexistuje, vytvořte ho. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
flush(number, FileFlushOptions)	Vyprázdní (zápisy) dříve připojená data k souboru.
generateSasStringToSign(FileGenerateSasUrlOptions)	K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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
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 (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán 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
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)	Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)	Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
query(string, FileQueryOptions)	Rychlý dotaz na formátovaný soubor 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 soubor ze služby, včetně jeho metadat a vlastností. V Node.jsvrátí data 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ě s vyrovnávací pamětí. Posun a počet jsou volitelné, předání 0 pro čtení celého souboru. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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ě s vyrovnávací pamětí. Posun a počet jsou volitelné, předání 0 pro čtení celého souboru Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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é, předat 0 a nedefinovat, aby bylo možné stáhnout celý soubor.
setExpiry(FileExpiryMode, FileSetExpiryOptions)	Nastaví u souboru čas vypršení platnosti, jakmile se tento čas odstraní.
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Nahraje vyrovnávací paměť(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 datový proud Node.js čitelný do souboru Data Lake. Tato metoda se pokusí vytvořit soubor a pak začne nahrávat blok dat podle bloků dat. Ujistěte se, že potenciální velikost datového proudu nepřekračuje FILE_MAX_SIZE_BYTES a potenciální počet bloků dat nepřekračuje BLOCK_BLOB_MAX_BLOCKS. TIPY KE ZLEPŠENÍ VÝKONU: Vstupní datový proud 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)	Pokud existuje, odstraňte aktuální cestu (adresář nebo soubor). 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; jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi.
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živatelsky 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 klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient, které vypisují cesty pomocí možnosti `includeMetadata`, což zachová původní velikost skříně. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Přesuňte adresář nebo soubor do stejného systému souborů. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Přesuňte 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 řízení přístupu 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í řízení přístupu na cestě a dílčích cestách. 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 není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou. Viz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Nastaví uživatelsky definovaná metadata pro zadanou cestu (adresář souboru) jako jeden nebo více dvojic název-hodnota. Pokud není k dispozici žádná možnost nebo v parametru nejsou definována žádná metadata, metadata cesty budou odebrána. 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()	Převeďte aktuální DataLakePathClient na DataLakeDirectoryClient, pokud je aktuální cesta adresář.
toFileClient()	Pokud je aktuální cesta souborem, převeďte aktuální DataLakePathClient na DataLakeFileClient.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Upraví řízení přístupu 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 Data Lake služby Azure Storage, 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 přizpůsobený 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 balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

options: StoragePipelineOptions

Volitelný. 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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

zděděné z DataLakePathClient.credential

url

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

url: string

Hodnota vlastnosti

string

zděděno zdataLakePathClient.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 trvale nahraná data, volání 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řipojování posunu v bajtech

length: number

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

options: FileAppendOptions

Volitelný. 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

Volitelný. 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

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

Návraty

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

Pokud soubor ještě neexistuje, vytvořte ho.

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

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

Parametry

options: FileCreateIfNotExistsOptions

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

Návraty

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Pokud soubor ještě neexistuje, vytvořte ho.

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í (zápisy) dříve připojená data k souboru.

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

Parametry

position: number

Umístění souboru k vyprázdnění Tento parametr umožňuje volajícímu nahrávat data paralelně a řídit pořadí, ve kterém je připojen k souboru. Vyžaduje se při nahrávání dat, která se mají připojit k souboru, a při vyprázdnění dříve nahraných dat do souboru. Hodnota musí být pozice, do které se mají připojit data. Nahraná data se do souboru okamžitě nevyprázdní ani nezapíšou. Pokud chcete vyprázdnit, musí být dříve nahraná data souvislá, musí být zadán parametr position a roven délce souboru po zápisu všech dat a nesmí existovat tělo entity požadavku zahrnuté do požadavku.

options: FileFlushOptions

Volitelný. Možnosti při vyprázdnění dat

Návraty

Promise<FileFlushResponse>

generateSasStringToSign(FileGenerateSasUrlOptions)

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

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán 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 generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

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 (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán 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, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

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

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

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey: UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

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

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

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey: UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

Promise<string>

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

query(string, FileQueryOptions)

Rychlý dotaz na formátovaný soubor 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 soubor ze služby, včetně jeho metadat a vlastností.

V Node.jsvrátí data 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

Volitelný. Posun na čtení souboru, výchozí hodnota je 0.

count: number

Volitelný. Kolik bajtů se má číst, výchozí hodnota se načte z posunu na konec.

options: FileReadOptions

Volitelný. 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ě s vyrovnávací pamětí. Posun a počet jsou volitelné, předání 0 pro čtení celého souboru.

Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. 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á číst. Přečte se na konec při předání nedefinovaného

options: FileReadToBufferOptions

Návraty

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

K DISPOZICI POUZE V NODE.JS RUNTIME

Načte soubor Data Lake paralelně s vyrovnávací pamětí. Posun a počet jsou volitelné, předání 0 pro čtení celého souboru

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á číst. Přečte se na konec při předání nedefinovaného

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é, předat 0 a nedefinovat, aby bylo možné stáhnout celý soubor.

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 na konec.

options: FileReadOptions

Možnosti čtení souboru Data Lake

Návraty

Promise<FileReadResponse>

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

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Nastaví u souboru čas vypršení platnosti, jakmile se tento čas 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 vyrovnávací paměť(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 datový proud Node.js čitelný do souboru Data Lake. Tato metoda se pokusí vytvořit soubor a pak začne nahrávat blok dat podle bloků dat. Ujistěte se, že potenciální velikost datového proudu nepřekračuje FILE_MAX_SIZE_BYTES a potenciální počet bloků dat nepřekračuje BLOCK_BLOB_MAX_BLOCKS.

TIPY KE ZLEPŠENÍ VÝKONU:

Vstupní datový proud 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 prostředek je adresář. Pokud je hodnota true, odstraní se všechny cesty pod adresářem.

options: PathDeleteOptions

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

Návraty

Promise<PathDeleteResponse>

zděděno zDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

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

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 prostředek je adresář. Pokud je hodnota 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; jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi.

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

Parametry

options: PathExistsOptions

možnosti pro operaci 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

Volitelný. 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

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

Návraty

DataLakeLeaseClient

zděděné zDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Vrátí všechna uživatelsky 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 klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodami DataLakeFileSystemClient, které vypisují cesty pomocí možnosti includeMetadata, což zachová původní velikost skříně.

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

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

Parametry

options: PathGetPropertiesOptions

Volitelný. 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 do 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

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

options: PathMoveOptions

Volitelný. 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řesuňte 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

Cílová cesta k adresáři, například "adresář" nebo cesta k souboru "adresář/soubor", pokud je cílová cesta ověřená pomocí SAS, přidejte sas do cílové cesty, například "directory/file?sasToken".

options: PathMoveOptions

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

Návraty

Promise<PathMoveResponse>

zděděno zDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Odebere řízení přístupu 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

Volitelný. Volby

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

zděděný 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

Volitelný. Možnosti při nastavování řízení přístupu k cestě

Návraty

Promise<PathSetAccessControlResponse>

zděděno zDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Nastaví řízení přístupu na cestě a dílčích cestách.

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

Volitelný. Volby

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

zděděný zDataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

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

Pokud není zadána žádná hodnota nebo není zadána žádná hodnota pro zadané hlavičky HTTP objektu blob, tyto hlavičky HTTP objektu blob bez hodnoty se vymažou.

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ěné zDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

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

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

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

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

Parametry

metadata: Metadata

Volitelný. Nahraďte stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.

options: PathSetMetadataOptions

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

Návraty

Promise<PathSetMetadataResponse>

zděděný 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

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

Návraty

Promise<PathSetPermissionsResponse>

zděděno zDataLakePathClient.setPermissions

toDirectoryClient()

Převeďte aktuální DataLakePathClient na DataLakeDirectoryClient, pokud je aktuální cesta adresář.

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í řízení přístupu 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

Volitelný. Volby

Návraty

Promise<PathChangeAccessControlRecursiveResponse>

zděděný 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

generateSasStringToSign(FileGenerateSasUrlOptions)

Parametry

Návraty

generateSasUrl(FileGenerateSasUrlOptions)

Parametry

Návraty

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Parametry

Návraty

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

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)