LIST

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime 10.3 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 between 1 and 1001 used to limit the number of objects returned. The default limit is 1001.

Examples

> LIST 's3://us-east-1-dev/some_dir' WITH (CREDENTIAL aws_some_dir) LIMIT 2
  path                               name   size modification_time
  ---------------------------------- ------ ---- -----------------
  s3://us-east-1-dev/some_dir/table1 table1 0    ...
  s3://us-east-1-dev/some_dir/table1 table1 0    ...