sandbox_directory_entries

Creates, updates, deletes, gets or lists a sandbox_directory_entries resource.

Overview

Name	sandbox_directory_entries
Type	Resource
Id	databricks_workspace.sandbox.sandbox_directory_entries

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string
file_type	string	Type of a sandbox filesystem entry without following its final symlink. (SANDBOX_FILE_TYPE_DIRECTORY, SANDBOX_FILE_TYPE_FILE, SANDBOX_FILE_TYPE_OTHER, SANDBOX_FILE_TYPE_SYMLINK)
group	string
mode	integer
modify_time	string (date-time)	Nanosecond precision is preserved on the wire.
owner	string
path	string
permissions	string
size	integer
symlink_target	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	sandbox_id, path, deployment_name, workspace_domain	page_size, page_token	Lists a directory's immediate children in UTF-8 name order. Later pages may reflect concurrent

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
path	string	Absolute UTF-8 path of the directory.
sandbox_id	string	The sandbox_id segment of the parent resource name (sandboxes/{sandbox_id}).
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})
page_size	integer	Zero uses the default of 1000; values above 1000 are clamped to 1000.
page_token	string	The token from a prior response. Keep parent and path unchanged between pages.

SELECT examples

list

Lists a directory's immediate children in UTF-8 name order. Later pages may reflect concurrent

SELECT
name,
file_type,
group,
mode,
modify_time,
owner,
path,
permissions,
size,
symlink_target
FROM databricks_workspace.sandbox.sandbox_directory_entries
WHERE sandbox_id = '{{ sandbox_id }}' -- required
AND path = '{{ path }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;