O que é a API de Arquivos?

A API de Arquivos é uma API HTTP padrão que permite ler, gravar, listar e excluir arquivos e diretórios referenciando seus URIs. A API torna o trabalho com conteúdo de arquivo como bytes brutos mais fácil e eficiente.

A API oferece suporte a volumes do Unity Catalog, onde você especifica os arquivos e diretórios nos quais operar usando seu caminho de URI de volume, que segue o formato /Volumes/<catalog_name>/<schema_name>/<volume_name>/<path_to_file>. O caminho é sempre absoluto.

A Files API possui dois Endpoint distintos: um para trabalhar com arquivos (/fs/files) e outro para trabalhar com diretórios (/fs/directories). Ambos os Endpoint usam os métodos HTTP padrão GET, HEAD, PUT, DELETE e POST para gerenciar arquivos e diretórios especificados pelo caminho do seu URI. Para cada operação e seus parâmetros, consulte a referência da Files API 3.0.

O uso da API de Arquivos pode incorrer em encargos de transferência de dados do Databricks.

Capacidades

Com a API de Arquivos, você pode:

• Faça upload de um arquivo de até 5000 MiB em uma única solicitação ou faça upload de um arquivo maior em partes com multipart upload.
• Faça download de um arquivo inteiro em uma única solicitação ou faça download de parte dele com o cabeçalho Range. Consulte download arquivos grandes com solicitações de intervalo.
• Faça com que uma leitura, gravação ou exclusão dependa do horário atual de ETag ou Last-Modified de um arquivo com solicitações condicionais.

Requisitos

• Envie solicitações para o hostname regional do seu workspace. Consulte Usar a Files API com o hostname regional.
• Conectividade de rede ao Databricks e ao seu armazenamento. Consulte Conectividade de rede para a API de arquivos.

Versões

A API de Arquivos tem duas versões. Para saber o que mudou entre elas, consulte Versões da API de Arquivos.