to_file Função

Aplica-se a:check marked yes Databricks SQL check marked yes Databricks Runtime 18 LTS and above

Importante

Esse recurso está em Beta.

Retorna um FILE valor que faz referência ao arquivo em path.

Sintaxe

to_file(path)

Arguments

  • path: Uma STRING expressão que especifica o caminho para um arquivo. Por exemplo, um caminho em um volume do Unity Catalog.

Returns

Um FILE valor que faz referência ao arquivo em path.

Para coletar metadados de arquivos, o Azure Databricks faz uma chamada remota para o local de armazenamento do arquivo. Se o arquivo não existir ou estiver inacessível, o Azure Databricks gera um erro. Para retornar NULL , use try_to_file função.

Condições de erro comuns

  • TO_FILE_ERROR.FILE_NOT_EXISTS
  • TO_FILE_AUTHORIZATION_ERROR.READ_UNAUTHORIZED
  • TO_FILE_ILLEGAL_USAGE.NO_PATH_PROVIDED

Para mais informações, veja Condições de erro no Azure Databricks.

Examples

Para criar uma FILE referência a partir de um caminho em um volume:

SELECT to_file('/Volumes/my_catalog/my_schema/my_volume/report.pdf');

Se o caminho não existir ou o usuário não tiver permissão de leitura, to_file gera um erro:

SELECT to_file('/Volumes/my_catalog/my_schema/my_volume/ghost.csv');
Error: TO_FILE_ERROR.FILE_NOT_EXISTS