to_file 関数

適用対象:はい Databricks SQL チェックが Databricks Runtime 18 LTS 以上" とマークされているチェック

Important

この機能は ベータ版です。 ワークスペース管理者は、[ プレビュー] ページからこの機能へのアクセスを制御できます。 Manage Azure Databricks プレビューを参照してください。

ファイルを参照する FILE 値を返します。 path

構文

to_file(path)

Arguments

  • path: ファイルのパスを指定する STRING 式です。 例えば、Unityカタログのボリューム内のパスなどです。

返品

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のエラー条件」をご覧ください。

例示

ボリューム内のパスから 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