to_file 函数

适用于:检查标记为“是”的 Databricks SQL 检查标记为“是”是 Databricks Runtime 18 LTS 及更高版本

Important

此功能在 Beta 版中。 工作区管理员可以从 预览 页控制对此功能的访问。 请参阅 Manage Azure Databricks 预览版

返回 FILE 一个引用文件的 path值。

Syntax

to_file(path)

Arguments

  • path: 一个 STRING 指定文件路径的表达式。 例如,Unity 目录卷中的一条路径。

Returns

一个 FILE 引用文件的 path值。

为了收集文件元数据,Azure Databricks 会远程调用文件的存储位置。 如果文件不存在或无法访问,Azure Databricks会报错。 要返回 NULL ,可以用 try_to_file 函数

常见错误条件

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

欲了解更多信息,请参见 Azure Databricks 中的错误条件

Examples

要从卷中的路径创建 FILE 引用:

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

如果路径不存在或用户缺乏读取权限,则 to_file 会触发错误:

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