DataLakeFileClient class

Создает экземпляр DataLakeFileClient из URL-адреса и конвейера.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Параметры

Создает экземпляр DataLakeFileClient из URL-адреса и учетных данных.

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

Параметры

Имя текущей файловой системы.

string fileSystemName

Значение свойства

Имя текущего пути (каталог или файл).

string name

Значение свойства

accountName: string

Значение свойства

наследуется отDataLakePathClient.accountName

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Значение свойства

унаследован отDataLakePathClient.credential

Закодированное строковое значение URL-адреса.

url: string

Значение свойства

наследуется отDataLakePathClient.url

Отправляет данные, добавляемые в файл. Данные могут быть добавлены только в файл. Чтобы применить постоянно отправленные данные к файлу, вызовите очистку.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

Создайте файл.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

Создайте файл.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

Создайте файл, если он еще не существует.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

Создайте файл, если он еще не существует.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

Очистка (запись) ранее добавленных данных в файл.

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

Параметры

Возвращаемое значение

Доступно только для клиентов, созданных с использованием учетных данных общего ключа.

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Доступно только для клиентов, созданных с использованием учетных данных общего ключа.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

Возвращаемое значение

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Быстрый запрос к формате JSON или CSV-файлу.

Пример использования (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(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

Параметры

Возвращаемое значение

Загружает файл из службы, включая его метаданные и свойства.

• В Node.jsданные возвращаются в потоке, доступном для чтения, доступном для чтенияStreamBody
• В браузерах данные возвращаются в содержимом PromiseAsBlob

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob.

• Пример использования (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(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Пример использования (браузер):

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

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Считывает файл Data Lake параллельно буферу. Смещение и число являются необязательными, передайте 0 для чтения всего файла.

Предупреждение. Буферы могут поддерживать только файлы до одного гигабайта в 32-разрядных системах или около двух гигабайтов в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рекомендуется readToFile.

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

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS

Считывает файл Data Lake параллельно буферу. Смещение и подсчет являются необязательными, передайте 0 для чтения всего файла.

Предупреждение. Буферы могут поддерживать только файлы до одного гигабайта в 32-разрядных системах или около двух гигабайтов в 64-разрядных системах из-за ограничений Node.js/V8. Для файлов, превышающих этот размер, рекомендуется readToFile.

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

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Загружает файл Data Lake в локальный файл. Завершается ошибкой, если указанный путь к файлу уже завершается. Смещение и подсчет являются необязательными, передайте 0 и не определено соответственно, чтобы скачать весь файл.

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

Параметры

Возвращаемое значение

Данные отклика для операции чтения файла, но при использовании readableStreamBody задано значение undefined, так как его содержимое уже считывается и записывается в локальный файл по указанному пути.

Задает время истечения срока действия файла после того, как это время будет удалено.

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

Параметры

Возвращаемое значение

Отправляет буфер (Node.js)/Blob/ArrayBuffer/ArrayBufferView в файл.

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

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Отправляет локальный файл в файл Data Lake.

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

Параметры

Возвращаемое значение

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Отправляет поток Node.js для чтения в файл Data Lake. Этот метод попытается создать файл, а затем начинает отправлять блоки по блоку. Убедитесь, что потенциальный размер потока не превышает FILE_MAX_SIZE_BYTES и потенциальное количество блоков не превышает BLOCK_BLOB_MAX_BLOCKS.

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

• Входной поток highWaterMark лучше задать то же значение с параметром options.chunkSize, что позволит избежать операций Buffer.concat().

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

Параметры

Возвращаемое значение

Удалите текущий путь (каталог или файл).

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.delete

Удалите текущий путь (каталог или файл), если он существует.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.

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

Параметры

Возвращаемое значение

унаследован отDataLakePathClient.deleteIfExists

Возвращает значение true, если файл Data Lake, представленный этим клиентом; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий файл может быть удален другими клиентами или приложениями. Наоборот, новые файлы могут быть добавлены другими клиентами или приложениями после завершения этой функции.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.существует

Возвращает данные управления доступом для пути (каталога файла).

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties.

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

Параметры

Возвращаемое значение

унаследовано отDataLakePathClient.getAccessControl

Получите DataLakeLeaseClient, которая управляет арендой пути (каталог или файл).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.getDataLakeLeaseClient

Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства пути (каталог или файл).

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методами DataLakeFileSystemClient, которые перечисляют пути с помощью параметра includeMetadata, который будет хранить исходный регистр.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.getProperties

Перемещение каталога или файла в одной файловой системе.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.move

Перемещение каталога или файла в другую файловую систему.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.move

Удаляет управление доступом по пути и вложенным путям.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.removeAccessControlRecursive

Задайте данные управления доступом для пути (каталога файла).

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

унаследован отDataLakePathClient.setAccessControl

Задает управление доступом по пути и вложенным путям.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.setAccessControlRecursive

Задает системные свойства пути (каталог или файл).

Если для указанных заголовков HTTP большого двоичного объекта не задано никакого значения, эти заголовки HTTP БОЛЬШИХ двоичных объектов без значения будут удалены.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.

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

Параметры

Возвращаемое значение

унаследовано отDataLakePathClient.setHttpHeaders

Задает пользовательские метаданные для указанного пути (каталога файла) как одну или несколько пар "имя-значение".

Если в параметре не указан параметр или метаданные, определенные в параметре, метаданные пути будут удалены.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.setMetadata

Задает разрешения на файл по пути.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

наследуется отDataLakePathClient.setPermissions

Преобразуйте текущий DataLakePathClient в DataLakeDirectoryClient, если текущий путь является каталогом.

function toDirectoryClient(): DataLakeDirectoryClient

Возвращаемое значение

унаследовано отDataLakePathClient.toDirectoryClient

Преобразуйте current DataLakePathClient в DataLakeFileClient, если текущий путь является файлом.

function toFileClient(): DataLakeFileClient

Возвращаемое значение

наследуется отDataLakePathClient.toFileClient

Изменяет управление доступом по пути и вложенным путям.

См. раздел https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

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

Параметры

Возвращаемое значение

унаследован отDataLakePathClient.updateAccessControlRecursive