Listar blobs com JavaScript

Esse artigo mostra como listar blobs usando a biblioteca de clientes do Armazenamento do Microsoft Azure para JavaScript.

Pré-requisitos

• Os exemplos neste artigo pressupõem que você já tenha um projeto configurado para trabalhar com a biblioteca de clientes do Armazenamento de Blobs do Azure para JavaScript. Para saber mais sobre a configuração do seu projeto, incluindo a instalação de pacotes, a importação de módulos e a criação de um objeto cliente autorizado para trabalhar com recursos de dados, confira Introdução ao Armazenamento de Blobs do Azure e o JavaScript.
• O mecanismo de autorização deve ter permissões para listar blobs. Para saber mais, consulte as diretrizes de autorização para as seguintes operações de API REST:
  • Listar Blobs

Sobre as opções de listagem de blobs

Ao listar blobs por meio do código, você pode especificar várias opções para gerenciar o modo como os resultados são retornados do Armazenamento do Microsoft Azure. Você pode especificar o número de resultados a serem retornados em cada conjunto de resultados e, em seguida, recuperar os conjuntos subsequentes. Você pode especificar um prefixo para retornar os blobs cujos nomes começam com esse caractere ou cadeia de caracteres. Além disso, você pode listar os blobs em uma estrutura de listagem plana ou hierarquicamente. Uma listagem hierárquica retorna blobs como se eles estivessem organizados em pastas.

Para listar os blobs em um contêiner usando uma listagem simples, chame o seguinte método:

• ContainerClient.listBlobsFlat

Para listar os blobs em um contêiner usando uma listagem hierárquica, chame o seguinte método:

• ContainerClient.listBlobsByHierarchy

Gerenciar quantos resultados são retornados

Por padrão, uma operação de listagem retorna até 5.000 resultados por vez, mas você pode especificar o número de resultados que deseja que cada operação de listagem retorne. Os exemplos apresentados neste artigo mostram como retornar resultados em páginas. Para saber mais sobre os conceitos de paginação, confira Paginação com o SDK do Azure para JavaScript.

Filtrar resultados com um prefixo

Para filtrar a lista de blobs, especifique uma cadeia de caracteres para a propriedade prefix em ContainerListBlobsOptions. A cadeia de caracteres de prefixo pode incluir um ou mais caracteres. Armazenamento do Azure retorna apenas os blobs cujos nomes começam com esse prefixo. Por exemplo, transmitir a cadeia de caracteres de prefixo sample- retorna apenas blobs cujos nomes começam com sample-.

Incluir metadados do blob ou outras informações

Para incluir metadados de blob com os resultados, defina a propriedade includeMetadata como true como parte de ContainerListBlobsOptions. Você também pode incluir snapshots, tags ou versões nos resultados ao definir a propriedade apropriada como true.

Listagem plana versus listagem hierárquica

Os blobs no Armazenamento do Azure são organizados em um paradigma simples em vez de um paradigma hierárquico (como um sistema de arquivos clássico). No entanto, você pode organizar blobs em diretórios virtuais para imitar a estrutura de uma pasta. Um diretório virtual faz parte do nome do blob e é indicado pelo caractere delimitador.

Para organizar blobs em diretórios virtuais, use um caractere delimitador no nome do blob. O caractere delimitador padrão é uma barra (/), mas você pode especificar qualquer caractere como o delimitador.

Se você nomeia seus blobs usando um delimitador, pode escolher listar os blobs hierarquicamente. Para uma operação de listagem hierárquica, o Armazenamento do Azure retornará os diretórios virtuais e blobs que estiverem abaixo do objeto pai. Você pode chamar a operação de listagem recursivamente para percorrer a hierarquia, semelhante ao modo como você percorreria um sistema de arquivos clássico programaticamente.

Usar uma listagem plana

Por padrão, uma operação de listagem retorna blobs em uma listagem plana. Em uma listagem plana, os blobs não são organizados por diretório virtual.

O exemplo a seguir lista os blobs no contêiner especificado usando uma listagem plana. Este exemplo inclui snapshots de blob e metadados de blob, se existirem:

async function listBlobsFlat(containerClient) {

  const maxPageSize = 2;

  // Some options for filtering results
  const listOptions = {
    includeMetadata: true,
    includeSnapshots: true,
    prefix: '' // Filter results by blob name prefix
  };

  console.log("Blobs flat list (by page):");
  for await (const response of containerClient
    .listBlobsFlat(listOptions)
    .byPage({ maxPageSize })) {
    console.log("- Page:");
    if (response.segment.blobItems) {
      for (const blob of response.segment.blobItems) {
        console.log(`  - ${blob.name}`);
      }
    }
  }
}

async function listBlobsFlat(
  containerClient: ContainerClient
): Promise<void> {
  
  const maxPageSize = 2;

  // Some options for filtering results
  const listOptions: ContainerListBlobsOptions = {
    includeMetadata: true,
    includeSnapshots: true,
    prefix: '' // Filter results by blob name prefix
  };

  console.log("Blobs flat list(by page):");
  for await (const response of containerClient
    .listBlobsFlat(listOptions)
    .byPage({ maxPageSize })) {
    console.log("- Page:");
    if (response.segment.blobItems) {
      for (const blob of response.segment.blobItems) {
        console.log(`  - ${blob.name}`);
      }
    }
  }
}

A saída de exemplo deverá ser semelhante a:

Blobs flat list (by page):
- Page:
  - a1
  - a2
- Page:
  - folder1/b1
  - folder1/b2
- Page:
  - folder2/sub1/c
  - folder2/sub1/d

Usar uma listagem hierárquica

Quando você chama uma operação de listagem hierarquicamente, o Armazenamento do Azure retorna os diretórios virtuais e os blobs no primeiro nível da hierarquia.

Para listar blobs hierarquicamente, use o seguinte método:

• BlobContainerClient.listBlobsByHierarchy

O exemplo a seguir lista os blobs no contêiner especificado usando uma listagem hierárquica. Neste exemplo, o parâmetro de prefixo é inicialmente definido como uma cadeia de caracteres vazia para listar todos os blobs no contêiner. Em seguida, o exemplo chama a operação de listagem de forma recursiva para percorrer a hierarquia de diretórios virtuais e listar os blobs.

// Recursively list virtual folders and blobs
async function listBlobHierarchical(containerClient, delimiter='/') {
  
  const maxPageSize = 20;

  // Some options for filtering list
  const listOptions = {
    prefix: '' // Filter results by blob name prefix   
  };

  let i = 1;
  console.log(`Folder ${delimiter}`);

  for await (const response of containerClient
    .listBlobsByHierarchy(delimiter, listOptions)
    .byPage({ maxPageSize })) {

    console.log(`   Page ${i++}`);
    const segment = response.segment;

    if (segment.blobPrefixes) {

      // Do something with each virtual folder
      for await (const prefix of segment.blobPrefixes) {

        // Build new delimiter from current and next
        await listBlobHierarchical(containerClient, `${delimiter}${prefix.name}`);
      }
    }

    for (const blob of response.segment.blobItems) {

      // Do something with each blob
      console.log(`\tBlobItem: name - ${blob.name}`);
    }
  }
}

// Recursively list virtual folders and blobs
async function listBlobHierarchical(
  containerClient: ContainerClient,
  delimiter = '/'
): Promise<void> {

  const maxPageSize = 20;

  // Some options for filtering results
  const listOptions: ContainerListBlobsOptions = {
    prefix: '' // Filter results by blob name prefix
  };

  let i = 1;
  console.log(`Folder ${delimiter}`);

  for await (const response of containerClient
    .listBlobsByHierarchy(delimiter, listOptions)
    .byPage({ maxPageSize })) {
    console.log(`   Page ${i++}`);
    const segment = response.segment;

    if (segment.blobPrefixes) {
      // Do something with each virtual folder
      for await (const prefix of segment.blobPrefixes) {
        // Build new delimiter from current and next
        await listBlobHierarchical(
          containerClient,
          `${delimiter}${prefix.name}`
        );
      }
    }

    for (const blob of response.segment.blobItems) {
      // Do something with each blob
      console.log(`\tBlobItem: name - ${blob.name}`);
    }
  }
}

A saída de exemplo deverá ser semelhante a:

Folder /
   Page 1
        BlobItem: name - a1
        BlobItem: name - a2
   Page 2
Folder /folder1/
   Page 1
        BlobItem: name - folder1/b1
        BlobItem: name - folder1/b2
Folder /folder2/
   Page 1
Folder /folder2/sub1/
   Page 1
        BlobItem: name - folder2/sub1/c
        BlobItem: name - folder2/sub1/d
   Page 2
        BlobItem: name - folder2/sub1/e

Listar blobs no formato Apache Arrow (versão prévia)

Essa funcionalidade é construída sobre a API existente List Blobs . Em vez de usar o XML padrão, usa o formato compacto e colunar Apache Arrow como formato de resposta na transmissão. Você habilita isso definindo uma única opção na chamada de listagem de contêineres. O SDK JavaScript decodifica o Apache Arrow nos bastidores e ainda retorna os mesmos objetos de blob. Essa abordagem melhora a taxa de transferência da listagem e reduz o uso de CPU no cliente ao enumerar contêineres grandes. Ela preserva o contrato de resposta do qual as aplicações dependem.

Para solicitar resultados formatados em Apache Arrow, defina a responseFormat propriedade das opções de listagem para StorageResponseFormat.Arrow, e depois passe as opções para ContainerClient.listBlobsFlat. Importe o StorageResponseFormat enum de @azure/storage-blob.

O exemplo a seguir lista os blobs em um contêiner e solicita os resultados no formato Apache Arrow:

const { StorageResponseFormat } = require("@azure/storage-blob");

const options = {
  prefix: "FolderA/",
  responseFormat: StorageResponseFormat.Arrow,
};

for await (const blob of containerClient.listBlobsFlat(options)) {
  console.log("Blob name: " + blob.name);
}

Recursos

Para saber mais sobre como listar blobs usando a biblioteca cliente Armazenamento de Blobs do Azure para JavaScript, veja os seguintes recursos.

Exemplos de código

• Veja exemplos de código JavaScript e TypeScript deste artigo no GitHub.

Operações da API REST

O SDK do Azure para JavaScript contém bibliotecas que se baseiam sobre a API REST do Azure. Ao usar essas bibliotecas, você pode interagir com operações da API REST por meio de paradigmas JavaScript familiares. Os métodos da biblioteca de clientes para listar blobs usam a seguinte operação de API REST:

• Listar Blobs (REST API)

Recursos da biblioteca de clientes

• Documentação de referência da biblioteca cliente
• Código-fonte da biblioteca de clientes
• Pacote (npm)

Confira também

• Listando recursos de Blob
• Controle de versão de blobs