DataLakeFileClient class

Odwołanie

Pakiet:: @azure/storage-file-datalake

Obiekt DataLakeFileClient reprezentuje adres URL pliku usługi Azure Storage.

Rozszerzenie: DataLakePathClient

Konstruktory

DataLakeFileClient(string, Pipeline)	Tworzy wystąpienie elementu DataLakeFileClient z adresu URL i potoku.
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie elementu DataLakeFileClient na podstawie adresu URL i poświadczeń.

Właściwości

fileSystemName	Nazwa bieżącego systemu plików.
name	Nazwa bieżącej ścieżki (katalogu lub pliku).

Właściwości dziedziczone

accountName
credential	Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu `@azure/identity` do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.
url	Wartość zakodowanego ciągu adresu URL.

Metody

append(RequestBodyType, number, number, FileAppendOptions)	Przekazuje dane do dołączania do pliku. Dane można dołączać tylko do pliku. Aby zastosować perviously przekazane dane do pliku, wywołaj funkcję flush. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
create(FileCreateOptions)	Utwórz plik. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	Utwórz plik. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(FileCreateIfNotExistsOptions)	Utwórz plik, jeśli jeszcze nie istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Utwórz plik, jeśli jeszcze nie istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
flush(number, FileFlushOptions)	Opróżnia (zapisy) wcześniej dołączane dane do pliku.
generateSasStringToSign(FileGenerateSasUrlOptions)	Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego. Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)	Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)	Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
query(string, FileQueryOptions)	Szybkie zapytanie dotyczące pliku w formacie JSON lub CSV. Przykładowe użycie (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)	Pobiera plik z usługi, w tym jego metadane i właściwości. W Node.jsdane są zwracane w strumieniu czytelnym do odczytuStreamBody W przeglądarkach dane są zwracane w zawartości obietnicyAsBlob Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob Przykładowe użycie (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); }); } Przykładowe użycie (przeglądarka): `// 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)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Odczytuje plik usługi Data Lake równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby odczytać cały plik. Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć readToFile.
readToBuffer(number, number, FileReadToBufferOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS Odczytuje plik usługi Data Lake równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby odczytać cały plik Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć readToFile.
readToFile(string, number, number, FileReadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Pobiera plik usługi Data Lake do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały plik.
setExpiry(FileExpiryMode, FileSetExpiryOptions)	Ustawia czas wygaśnięcia pliku, gdy ten czas zostanie spełniony, plik zostanie usunięty.
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Przekazuje bufor(Node.js)/Blob/ArrayBuffer/ArrayBufferView do pliku.
uploadFile(string, FileParallelUploadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje plik lokalny do pliku usługi Data Lake.
uploadStream(Readable, FileParallelUploadOptions)	DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS. Przekazuje strumień z możliwością odczytu Node.js do pliku usługi Data Lake. Ta metoda spróbuje utworzyć plik, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Upewnij się, że potencjalny rozmiar strumienia nie przekracza FILE_MAX_SIZE_BYTES, a potencjalna liczba fragmentów nie przekracza BLOCK_BLOB_MAX_BLOCKS. PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI: Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość za pomocą parametru options.chunkSize, co pozwoli uniknąć operacji Buffer.concat().

Metody dziedziczone

delete(boolean, PathDeleteOptions)	Usuń bieżącą ścieżkę (katalog lub plik). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	Usuń bieżącą ścieżkę (katalog lub plik), jeśli istnieje. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Zwraca wartość true, jeśli plik usługi Data Lake reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false. UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
getAccessControl(PathGetAccessControlOptions)	Zwraca dane kontroli dostępu dla ścieżki (katalogu pliku). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	Pobierz DataLakeLeaseClient, który zarządza dzierżawami w ścieżce (katalogu lub pliku).
getProperties(PathGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla ścieżki (katalogu lub pliku). OSTRZEŻENIE: Obiekt `metadata` zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient, że ścieżki listy przy użyciu opcji `includeMetadata`, która zachowa oryginalną wielkość liter. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Przenieś katalog lub plik w tym samym systemie plików. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Przenieś katalog lub plik do innego systemu plików. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Usuwa kontrolę dostępu w ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	Ustaw dane kontroli dostępu dla ścieżki (katalogu pliku). Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Ustawia kontrolę dostępu na ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Ustawia właściwości systemu na ścieżce (katalog lub plik). Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	Ustawia metadane zdefiniowane przez użytkownika dla określonej ścieżki (katalogu pliku) jako co najmniej jedną parę nazwa-wartość. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane ścieżki zostaną usunięte. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	Ustawia uprawnienia do pliku na ścieżce. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	Przekonwertuj bieżący element DataLakePathClient na element DataLakeDirectoryClient, jeśli bieżąca ścieżka jest katalogiem.
toFileClient()	Przekonwertuj bieżący element DataLakePathClient na element DataLakeFileClient, jeśli bieżąca ścieżka jest plikiem.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Modyfikuje kontrolę dostępu w ścieżce i ścieżkach podrzędnych. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

Szczegóły konstruktora

DataLakeFileClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakeFileClient z adresu URL i potoku.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parametry

url: string

Ciąg klienta wskazujący plik data lake usługi Azure Storage, taki jak "https://myaccount.dfs.core.windows.net/filesystem/file". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".

pipeline: Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

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

Tworzy wystąpienie elementu DataLakeFileClient na podstawie adresu URL i poświadczeń.

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

fileSystemName

Nazwa bieżącego systemu plików.

string fileSystemName

Wartość właściwości

string

name

Nazwa bieżącej ścieżki (katalogu lub pliku).

string name

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName

accountName: string

Wartość właściwości

string

dziedziczone zDataLakePathClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

dziedziczone zDataLakePathClient.credential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone zDataLakePathClient.url

Szczegóły metody

append(RequestBodyType, number, number, FileAppendOptions)

Przekazuje dane do dołączania do pliku. Dane można dołączać tylko do pliku. Aby zastosować perviously przekazane dane do pliku, wywołaj funkcję flush.

Zobacz 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

Zawartość do przekazania.

offset: number

Dołącz przesunięcie w bajtach.

length: number

Długość zawartości dołączanej w bajtach.

options: FileAppendOptions

Fakultatywny. Opcje podczas dołączania danych.

Zwraca

Promise<FileAppendResponse>

create(FileCreateOptions)

Utwórz plik.

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

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

Parametry

options: FileCreateOptions

Fakultatywny. Opcje podczas tworzenia pliku.

Zwraca

Promise<FileCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

Utwórz plik.

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

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

Parametry

resourceType: PathResourceTypeModel

Typ zasobu musi mieć wartość "file" dla elementu DataLakeFileClient.

options: PathCreateOptions

Fakultatywny. Opcje podczas tworzenia pliku.

Zwraca

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

Utwórz plik, jeśli jeszcze nie istnieje.

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

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

Parametry

options: FileCreateIfNotExistsOptions

Fakultatywny. Opcje podczas tworzenia pliku.

Zwraca

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Utwórz plik, jeśli jeszcze nie istnieje.

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

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

Parametry

resourceType: PathResourceTypeModel

Typ zasobu musi mieć wartość "file" dla elementu DataLakeFileClient.

options: PathCreateIfNotExistsOptions

Zwraca

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

Opróżnia (zapisy) wcześniej dołączane dane do pliku.

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

Parametry

position: number

Położenie pliku do opróżnienia. Ten parametr umożliwia obiektowi wywołującym równoległe przekazywanie danych i kontrolowanie kolejności dołączania ich do pliku. Jest to wymagane podczas przekazywania danych do dołączania do pliku i opróżniania wcześniej przekazanych danych do pliku. Wartość musi być pozycją, w której dane mają być dołączane. Przekazane dane nie są natychmiast opróżniane ani zapisywane w pliku. Aby opróżnić, wcześniej przekazane dane muszą być ciągłe, parametr pozycji musi być określony i równy długości pliku po zapisaniu wszystkich danych i nie może istnieć treść jednostki żądania dołączona do żądania.

options: FileFlushOptions

Fakultatywny. Opcje podczas opróżniania danych.

Zwraca

Promise<FileFlushResponse>

generateSasStringToSign(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametry

options: FileGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateSasUrl(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

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

Parametry

options: FileGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

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

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

Parametry

options: FileGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey: UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

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

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

Parametry

options: FileGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey: UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

query(string, FileQueryOptions)

Szybkie zapytanie dotyczące pliku w formacie JSON lub CSV.

Przykładowe użycie (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

Zwraca

Promise<FileReadResponse>

read(number, number, FileReadOptions)

Pobiera plik z usługi, w tym jego metadane i właściwości.

W Node.jsdane są zwracane w strumieniu czytelnym do odczytuStreamBody
W przeglądarkach dane są zwracane w zawartości obietnicyAsBlob

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

Przykładowe użycie (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);
  });
}

Przykładowe użycie (przeglądarka):

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

Fakultatywny. Przesunięcie do odczytu pliku, wartość domyślna to 0.

count: number

Fakultatywny. Ile bajtów do odczytu, wartość domyślna będzie odczytywana z przesunięcia na koniec.

options: FileReadOptions

Fakultatywny. Opcje podczas odczytywania pliku.

Zwraca

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Odczytuje plik usługi Data Lake równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby odczytać cały plik.

Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć readToFile.

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

Parametry

buffer: Buffer

Bufor do wypełnienia, musi mieć długość większą niż liczba

offset: number

Z której pozycji pliku usługi Data Lake do odczytu

count: number

Ile danych należy odczytać. Odczytuje na końcu podczas przekazywania niezdefiniowane

options: FileReadToBufferOptions

Zwraca

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS

Odczytuje plik usługi Data Lake równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby odczytać cały plik

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

Parametry

offset: number

Z której pozycji pliku data lake do odczytu (w bajtach)

count: number

Ile danych (w bajtach) mają być odczytywane. Odczytuje na końcu podczas przekazywania niezdefiniowane

options: FileReadToBufferOptions

Zwraca

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera plik usługi Data Lake do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały plik.

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

Parametry

filePath: string

offset: number

Z której pozycji pliku do pobrania.

count: number

Ile danych należy pobrać. Po przekazaniu niezdefiniowanego zostanie pobrany koniec.

options: FileReadOptions

Opcje odczytu pliku usługi Data Lake.

Zwraca

Promise<FileReadResponse>

Dane odpowiedzi dla operacji odczytu pliku, ale z funkcją readableStreamBody ustawioną na niezdefiniowaną, ponieważ jego zawartość jest już odczytywana i zapisywana w pliku lokalnym w określonej ścieżce.

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Ustawia czas wygaśnięcia pliku, gdy ten czas zostanie spełniony, plik zostanie usunięty.

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

Parametry

mode: FileExpiryMode

options: FileSetExpiryOptions

Zwraca

Promise<FileSetExpiryResponse>

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

Przekazuje bufor(Node.js)/Blob/ArrayBuffer/ArrayBufferView do pliku.

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

Parametry

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer lub ArrayBufferView

options: FileParallelUploadOptions

Zwraca

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Przekazuje plik lokalny do pliku usługi Data Lake.

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

Parametry

filePath: string

Pełna ścieżka pliku lokalnego

options: FileParallelUploadOptions

Zwraca

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Przekazuje strumień z możliwością odczytu Node.js do pliku usługi Data Lake. Ta metoda spróbuje utworzyć plik, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Upewnij się, że potencjalny rozmiar strumienia nie przekracza FILE_MAX_SIZE_BYTES, a potencjalna liczba fragmentów nie przekracza BLOCK_BLOB_MAX_BLOCKS.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość za pomocą parametru options.chunkSize, co pozwoli uniknąć operacji Buffer.concat().

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

Parametry

stream: Readable

Node.js strumienia z możliwością odczytu.

options: FileParallelUploadOptions

Zwraca

Promise<FileUploadResponse>

Szczegóły metody dziedziczonej

delete(boolean, PathDeleteOptions)

Usuń bieżącą ścieżkę (katalog lub plik).

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

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

Parametry

recursive: boolean

Wymagane i prawidłowe tylko wtedy, gdy zasób jest katalogiem. Jeśli wartość "true", wszystkie ścieżki poniżej katalogu zostaną usunięte.

options: PathDeleteOptions

Fakultatywny. Opcje podczas usuwania ścieżki.

Zwraca

Promise<PathDeleteResponse>

dziedziczone zDataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

Usuń bieżącą ścieżkę (katalog lub plik), jeśli istnieje.

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

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

Parametry

recursive: boolean

Wymagane i prawidłowe tylko wtedy, gdy zasób jest katalogiem. Jeśli wartość "true", wszystkie ścieżki poniżej katalogu zostaną usunięte.

options: PathDeleteOptions

Zwraca

Promise<PathDeleteIfExistsResponse>

dziedziczone zDataLakePathClient.deleteIfExists

exists(PathExistsOptions)

Zwraca wartość true, jeśli plik usługi Data Lake reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options: PathExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

dziedziczone zDataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

Zwraca dane kontroli dostępu dla ścieżki (katalogu pliku).

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

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

Parametry

options: PathGetAccessControlOptions

Fakultatywny. Opcje podczas uzyskiwania kontroli dostępu do plików.

Zwraca

Promise<PathGetAccessControlResponse>

dziedziczone zDataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

Pobierz DataLakeLeaseClient, który zarządza dzierżawami w ścieżce (katalogu lub pliku).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId: string

Fakultatywny. Początkowy proponowany identyfikator dzierżawy.

Zwraca

DataLakeLeaseClient

dziedziczone zDataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla ścieżki (katalogu lub pliku).

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metody DataLakeFileSystemClient, że ścieżki listy przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

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

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

Parametry

options: PathGetPropertiesOptions

Fakultatywny. Opcje podczas pobierania właściwości ścieżki.

Zwraca

Promise<PathGetPropertiesResponse>

dziedziczone zDataLakePathClient.getProperties

move(string, PathMoveOptions)

Przenieś katalog lub plik w tym samym systemie plików.

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

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

Parametry

destinationPath: string

Docelowa ścieżka katalogu, na przykład "katalog" lub ścieżka pliku "katalog/plik". Jeśli parametr destinationPath jest uwierzytelniany przy użyciu sygnatury dostępu współdzielonego, dodaj sygnaturę dostępu współdzielonego do ścieżki docelowej, takiej jak "directory/file?sasToken".

options: PathMoveOptions

Fakultatywny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

dziedziczone zDataLakePathClient.move

move(string, string, PathMoveOptions)

Przenieś katalog lub plik do innego systemu plików.

Zobacz 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

Docelowy system plików, taki jak "filesystem".

destinationPath: string

Ścieżka katalogu docelowego, na przykład "katalog" lub ścieżka pliku "katalog/plik", jeśli ścieżka destinationPath jest uwierzytelniona przy użyciu sygnatury dostępu współdzielonego, dodaj sygnaturę dostępu współdzielonego do ścieżki docelowej, takiej jak "katalog/plik?sasToken".

options: PathMoveOptions

Fakultatywny. Opcje podczas przenoszenia katalogu lub pliku.

Zwraca

Promise<PathMoveResponse>

dziedziczone zDataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Usuwa kontrolę dostępu w ścieżce i ścieżkach podrzędnych.

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

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

Parametry

acl: RemovePathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options: PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

Ustaw dane kontroli dostępu dla ścieżki (katalogu pliku).

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

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

Parametry

acl: PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options: PathSetAccessControlOptions

Fakultatywny. Opcje podczas ustawiania kontroli dostępu ścieżki.

Zwraca

Promise<PathSetAccessControlResponse>

dziedziczone zDataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Ustawia kontrolę dostępu na ścieżce i ścieżkach podrzędnych.

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

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

Parametry

acl: PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options: PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Ustawia właściwości systemu na ścieżce (katalog lub plik).

Jeśli żadna wartość nie zostanie podana lub żadna wartość podana dla określonych nagłówków HTTP obiektu blob, te nagłówki HTTP obiektu blob bez wartości zostaną wyczyszczone.

Zobacz 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

Zwraca

Promise<PathSetHttpHeadersResponse>

dziedziczone zDataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

Ustawia metadane zdefiniowane przez użytkownika dla określonej ścieżki (katalogu pliku) jako co najmniej jedną parę nazwa-wartość.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane ścieżki zostaną usunięte.

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

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

Parametry

metadata: Metadata

Fakultatywny. Zastąp istniejące metadane tą wartością. Jeśli żadna wartość nie zostanie podana, istniejące metadane zostaną usunięte.

options: PathSetMetadataOptions

Fakultatywny. Opcje podczas ustawiania metadanych ścieżki.

Zwraca

Promise<PathSetMetadataResponse>

dziedziczone zDataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

Ustawia uprawnienia do pliku na ścieżce.

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

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

Parametry

permissions: PathPermissions

Uprawnienia dostępu do pliku POSIX dla właściciela pliku, grupy właściciela pliku i innych.

options: PathSetPermissionsOptions

Fakultatywny. Opcje podczas ustawiania uprawnień ścieżki.

Zwraca

Promise<PathSetPermissionsResponse>

dziedziczone zDataLakePathClient.setPermissions

toDirectoryClient()

Przekonwertuj bieżący element DataLakePathClient na element DataLakeDirectoryClient, jeśli bieżąca ścieżka jest katalogiem.

function toDirectoryClient(): DataLakeDirectoryClient

Zwraca

DataLakeDirectoryClient

dziedziczone zDataLakePathClient.toDirectoryClient

toFileClient()

Przekonwertuj bieżący element DataLakePathClient na element DataLakeFileClient, jeśli bieżąca ścieżka jest plikiem.

function toFileClient(): DataLakeFileClient

Zwraca

DataLakeFileClient

dziedziczone zDataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Modyfikuje kontrolę dostępu w ścieżce i ścieżkach podrzędnych.

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

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

Parametry

acl: PathAccessControlItem[]

Lista kontroli dostępu POSIX dla pliku lub katalogu.

options: PathChangeAccessControlRecursiveOptions

Fakultatywny. Opcje

Zwraca

Promise<PathChangeAccessControlRecursiveResponse>

dziedziczone zDataLakePathClient.updateAccessControlRecursive

Udostępnij za pośrednictwem

DataLakeFileClient class

Konstruktory

Właściwości

Właściwości dziedziczone

Metody

Metody dziedziczone

Szczegóły konstruktora

DataLakeFileClient(string, Pipeline)

Parametry

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

Parametry

Szczegóły właściwości

fileSystemName

Wartość właściwości

name

Wartość właściwości

Szczegóły właściwości dziedziczonej

accountName

Wartość właściwości

credential

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

append(RequestBodyType, number, number, FileAppendOptions)

Parametry

Zwraca

create(FileCreateOptions)

Parametry

Zwraca

create(PathResourceTypeModel, PathCreateOptions)

Parametry

Zwraca

createIfNotExists(FileCreateIfNotExistsOptions)

Parametry

Zwraca

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

Parametry

Zwraca

flush(number, FileFlushOptions)

Parametry

Zwraca

generateSasStringToSign(FileGenerateSasUrlOptions)

Parametry

Zwraca

generateSasUrl(FileGenerateSasUrlOptions)

Parametry

Zwraca

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

Parametry

Zwraca

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

Parametry

Zwraca

query(string, FileQueryOptions)

Parametry

Zwraca

read(number, number, FileReadOptions)

Parametry

Zwraca

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

Parametry

Zwraca

readToBuffer(number, number, FileReadToBufferOptions)

Parametry

Zwraca

readToFile(string, number, number, FileReadOptions)

Parametry

Zwraca

setExpiry(FileExpiryMode, FileSetExpiryOptions)

Parametry

Zwraca

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

Parametry

Zwraca

uploadFile(string, FileParallelUploadOptions)

Parametry

Zwraca

uploadStream(Readable, FileParallelUploadOptions)