provider_files

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

Overview

Name	provider_files
Type	Resource
Id	databricks_workspace.marketplace.provider_files

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶file_info	object

list

Name	Datatype	Description
id	string
display_name	string	Name displayed to users for applicable files, e.g. embedded notebooks
created_at	integer
download_link	string
▶file_parent	object
marketplace_file_type	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> &gt;&gt;&gt; Color.RED<br /> &lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br /> &gt;&gt;&gt; Color(1)<br /> &lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br /> &gt;&gt;&gt; Color['RED']<br /> &lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (APP, EMBEDDED_NOTEBOOK, PROVIDER_ICON)
mime_type	string
status	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> &gt;&gt;&gt; Color.RED<br /> &lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br /> &gt;&gt;&gt; Color(1)<br /> &lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br /> &gt;&gt;&gt; Color['RED']<br /> &lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (FILE_STATUS_PUBLISHED, FILE_STATUS_SANITIZATION_FAILED, FILE_STATUS_SANITIZING, FILE_STATUS_STAGING)
status_message	string	Populated if status is in a failed state with more information on reason for the failure.
updated_at	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	file_id, deployment_name, workspace_domain		Get a file
list	select	file_parent, deployment_name, workspace_domain	page_size, page_token	List files attached to a parent entity.
create	insert	deployment_name, workspace_domain, file_parent, marketplace_file_type, mime_type		Create a file. Currently, only provider icons and attached notebooks are supported.
delete	delete	file_id, deployment_name, workspace_domain		Delete a file

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)
file_id	string
file_parent	object
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
page_token	string

SELECT examples

get

Get a file

SELECT
file_info
FROM databricks_workspace.marketplace.provider_files
WHERE file_id = '{{ file_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

List files attached to a parent entity.

SELECT
id,
display_name,
created_at,
download_link,
file_parent,
marketplace_file_type,
mime_type,
status,
status_message,
updated_at
FROM databricks_workspace.marketplace.provider_files
WHERE file_parent = '{{ file_parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Create a file. Currently, only provider icons and attached notebooks are supported.

INSERT INTO databricks_workspace.marketplace.provider_files (
file_parent,
marketplace_file_type,
mime_type,
display_name,
deployment_name,
workspace_domain
)
SELECT 
'{{ file_parent }}' /* required */,
'{{ marketplace_file_type }}' /* required */,
'{{ mime_type }}' /* required */,
'{{ display_name }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
file_info,
upload_url
;

Manifest

# Description fields are for documentation purposes
- name: provider_files
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_files resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the provider_files resource.
  - name: file_parent
    value:
      file_parent_type: "{{ file_parent_type }}"
      parent_id: "{{ parent_id }}"
  - name: marketplace_file_type
    value: "{{ marketplace_file_type }}"
    description: |
      Create a collection of name/value pairs.
      Example enumeration:
      >>> class Color(Enum):
      ...     RED = 1
      ...     BLUE = 2
      ...     GREEN = 3
      Access them by:
      - attribute access:
      >>> Color.RED
      <Color.RED: 1>
      - value lookup:
      >>> Color(1)
      <Color.RED: 1>
      - name lookup:
      >>> Color['RED']
      <Color.RED: 1>
      Enumerations can be iterated over, and know how many members they have:
      >>> len(Color)
      3
      >>> list(Color)
      [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
      Methods can be added to enumerations, and members can have their own
      attributes -- see the documentation for details.
  - name: mime_type
    value: "{{ mime_type }}"
  - name: display_name
    value: "{{ display_name }}"

DELETE examples

delete

Delete a file

DELETE FROM databricks_workspace.marketplace.provider_files
WHERE file_id = '{{ file_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
;