DataLakeFileClient class

Cria uma instância de DataLakeFileClient a partir de url e pipeline.

new DataLakeFileClient(url: string, pipeline: Pipeline)

Parâmetros

Cria uma instância de DataLakeFileClient a partir de url e credencial.

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

Parâmetros

Nome do sistema de arquivos atual.

string fileSystemName

Valor de Propriedade

Nome do caminho atual (diretório ou arquivo).

string name

Valor de Propriedade

accountName: string

Valor de Propriedade

herdado de DataLakePathClient.accountName

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

herdado de DataLakePathClient.credential

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

herdado de DataLakePathClient.url

Carrega dados para serem anexados a um arquivo. Os dados só podem ser anexados a um ficheiro. Para aplicar dados carregados permanentemente a um arquivo, chame flush.

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

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

Parâmetros

Devoluções

Crie um arquivo.

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

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

Parâmetros

Devoluções

Crie um arquivo.

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

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

Parâmetros

Devoluções

Crie um arquivo se ele ainda não existir.

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

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

Parâmetros

Devoluções

Crie um arquivo se ele ainda não existir.

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

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

Parâmetros

Devoluções

Libera (grava) dados anexados anteriormente a um arquivo.

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

Parâmetros

Devoluções

Disponível apenas para clientes construídos com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Disponível apenas para clientes construídos com uma credencial de chave compartilhada.

Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

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

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

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela chave de delegação do usuário de entrada.

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

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

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. A SAS é assinada pela chave de delegação do usuário de entrada.

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

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

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Consulta rápida para um arquivo formatado em JSON ou CSV.

Exemplo de utilização (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>

Parâmetros

Devoluções

Baixa um arquivo do serviço, incluindo seus metadados e propriedades.

• No Node.js, os dados retornam em um fluxo legível readableStreamBody
• Em navegadores, os dados retornam em um conteúdo prometidoAsBlob

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

• Exemplo de utilização (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);
  });
}

Exemplo de utilização (browser):

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

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Lê um arquivo Data Lake em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos lerem o arquivo inteiro.

Aviso: Os buffers só podem suportar arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para arquivos maiores que esse tamanho, considere readToFile.

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

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS

Lê um arquivo Data Lake em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos lerem o arquivo inteiro

Aviso: Os buffers só podem suportar arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para arquivos maiores que esse tamanho, considere readToFile.

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

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Baixa um arquivo Data Lake para um arquivo local. Falhará se o caminho do arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, respectivamente, para baixar o arquivo inteiro.

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

Parâmetros

Devoluções

Os dados de resposta para a operação de leitura de arquivo, mas com readableStreamBody definido como undefined uma vez que seu conteúdo já é lido e gravado em um arquivo local no caminho especificado.

Define um tempo de expiração em um arquivo, uma vez que esse tempo é cumprido, o arquivo é excluído.

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

Parâmetros

Devoluções

Carrega um Buffer(Node.js)/Blob/ArrayBuffer/ArrayBufferView para um arquivo.

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

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Carrega um arquivo local em um arquivo Data Lake.

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

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Carrega um fluxo legível Node.js em um arquivo Data Lake. Este método tentará criar um arquivo e, em seguida, começará a carregar bloco por bloco. Certifique-se de que o tamanho potencial do fluxo não exceda FILE_MAX_SIZE_BYTES e o número potencial de blocos não exceda BLOCK_BLOB_MAX_BLOCKS.

DICAS DE MELHORIA DE DESEMPENHO:

• O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro options.chunkSize, o que evitará operações Buffer.concat().

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

Parâmetros

Devoluções

Exclua o caminho atual (diretório ou arquivo).

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.delete

Exclua o caminho atual (diretório ou arquivo), se existir.

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.deleteIfExists

Retorna true se o arquivo Data Lake representado por este cliente existir; falso caso contrário.

NOTA: utilize esta função com cuidado, uma vez que um ficheiro existente pode ser eliminado por outros clientes ou aplicações. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.

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

Parâmetros

Devoluções

herdado deDataLakePathClient.exists

Retorna os dados de controle de acesso para um caminho (diretório de arquivo).

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.getAccessControl

Obtenha um DataLakeLeaseClient que gerencia concessões no caminho (diretório ou arquivo).

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

Devoluções

herdado de DataLakePathClient.getDataLakeLeaseClient

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o caminho (diretório ou arquivo).

AVISO: O objeto metadata retornado na resposta terá suas teclas em minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelos métodos de DataLakeFileSystemClient que listam caminhos usando a opção includeMetadata, que manterá seu invólucro original.

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.getProperties

Mova o diretório ou arquivo dentro do mesmo sistema de arquivos.

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.move

Mova o diretório ou arquivo para outro sistema de arquivos.

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.move

Remove o Controle de Acesso em um caminho e subcaminhos.

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.removeAccessControlRecursive

Defina os dados de controle de acesso para um caminho (diretório de arquivo).

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.setAccessControl

Define o Controle de Acesso em um caminho e subcaminhos.

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.setAccessControlRecursive

Define as propriedades do sistema no caminho (diretório ou arquivo).

Se nenhum valor fornecido, ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.setHttpHeaders

Define metadados definidos pelo usuário para o caminho especificado (diretório de arquivo) como um ou mais pares nome-valor.

Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do caminho serão removidos.

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.setMetadata

Define as permissões de arquivo em um caminho.

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

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

Parâmetros

Devoluções

herdado deDataLakePathClient.setPermissions

Converta DataLakePathClient atual em DataLakeDirectoryClient se o caminho atual for um diretório.

function toDirectoryClient(): DataLakeDirectoryClient

Devoluções

herdado de DataLakePathClient.toDirectoryClient

Converta DataLakePathClient atual em DataLakeFileClient se o caminho atual for um arquivo.

function toFileClient(): DataLakeFileClient

Devoluções

herdado deDataLakePathClient.toFileClient

Modifica o Controle de Acesso em um caminho e subcaminhos.

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

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

Parâmetros

Devoluções

herdado de DataLakePathClient.updateAccessControlRecursive