provider_exchange_filters

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

Overview

Name	provider_exchange_filters
Type	Resource
Id	databricks_workspace.marketplace.provider_exchange_filters

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string
name	string
exchange_id	string
created_at	integer
created_by	string
filter_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. (GLOBAL_METASTORE_ID)
filter_value	string
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	exchange_id, deployment_name, workspace_domain	page_size, page_token	List exchange filter
create	insert	deployment_name, workspace_domain, filter		Add an exchange filter.
update	replace	id, deployment_name, workspace_domain, filter		Update an exchange filter.
delete	delete	id, deployment_name, workspace_domain		Delete an exchange filter

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)
exchange_id	string
id	string
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

list

List exchange filter

SELECT
id,
name,
exchange_id,
created_at,
created_by,
filter_type,
filter_value,
updated_at,
updated_by
FROM databricks_workspace.marketplace.provider_exchange_filters
WHERE exchange_id = '{{ exchange_id }}' -- 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

Add an exchange filter.

INSERT INTO databricks_workspace.marketplace.provider_exchange_filters (
filter,
deployment_name,
workspace_domain
)
SELECT 
'{{ filter }}' /* required */,
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
filter_id
;

Manifest

# Description fields are for documentation purposes
- name: provider_exchange_filters
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_exchange_filters resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the provider_exchange_filters resource.
  - name: filter
    value:
      exchange_id: "{{ exchange_id }}"
      filter_value: "{{ filter_value }}"
      filter_type: "{{ filter_type }}"
      created_at: {{ created_at }}
      created_by: "{{ created_by }}"
      id: "{{ id }}"
      name: "{{ name }}"
      updated_at: {{ updated_at }}
      updated_by: "{{ updated_by }}"

REPLACE examples

update

Update an exchange filter.

REPLACE databricks_workspace.marketplace.provider_exchange_filters
SET 
filter = '{{ filter }}'
WHERE 
id = '{{ id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
AND filter = '{{ filter }}' --required
RETURNING
filter;

DELETE examples

delete

Delete an exchange filter

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