LIST

  • Article

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime 10.4 LTS and above check marked yes Unity Catalog only

Lists the objects immediately contained at the URL.

Syntax

LIST url [ WITH ( CREDENTIAL credential_name ) ] [ LIMIT limit ]

Parameters

  • url

    A STRING literal with the location of the cloud storage described as an absolute URL.

  • credential_name

    An optional named credential used to access this URL. If you supply a credential it must be sufficient to access the URL. If you do not supply a credential the URL must be contained in an external location to to which you have access.

  • limit

    An optional INTEGER constant used to limit the number of objects returned.

    In Databricks Runtime 10.4 LTS the default limit is 1001 and only values between 1 and 1001 are supported.

Examples

> LIST 'abfss://container@storageaccount.dfs.core.chinacloudapi.cn/some_dir' WITH (CREDENTIAL azure_some_dir) LIMIT 2
  path                                                                  name   size modification_time
  --------------------------------------------------------------------- ------ ---- -----------------
  abfss://container@storageaccount.dfs.core.chinacloudapi.cn/some_dir/table1 table1 0    ...
  abfss://container@storageaccount.dfs.core.chinacloudapi.cn/some_dir/table1 table1 0    ...