provider_exchanges

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

Overview

Name	provider_exchanges
Type	Resource
Id	databricks_workspace.marketplace.provider_exchanges

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶exchange	object

list

Name	Datatype	Description
id	string
name	string
comment	string
created_at	integer
created_by	string
▶filters	array
▶linked_listings	array
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, deployment_name, workspace_domain		Get an exchange.
list	select	deployment_name, workspace_domain	page_size, page_token	List exchanges visible to provider
create	insert	deployment_name, workspace_domain, exchange		Create an exchange
update	replace	id, deployment_name, workspace_domain, exchange		Update an exchange
delete	delete	id, deployment_name, workspace_domain		This removes a listing from marketplace.

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)
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

get

Get an exchange.

SELECT
exchange
FROM databricks_workspace.marketplace.provider_exchanges
WHERE id = '{{ id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

List exchanges visible to provider

SELECT
id,
name,
comment,
created_at,
created_by,
filters,
linked_listings,
updated_at,
updated_by
FROM databricks_workspace.marketplace.provider_exchanges
WHERE 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 an exchange

INSERT INTO databricks_workspace.marketplace.provider_exchanges (
exchange,
deployment_name,
workspace_domain
)
SELECT 
'{{ exchange }}' /* required */,
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
exchange_id
;

Manifest

# Description fields are for documentation purposes
- name: provider_exchanges
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_exchanges resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the provider_exchanges resource.
  - name: exchange
    value:
      name: "{{ name }}"
      comment: "{{ comment }}"
      created_at: {{ created_at }}
      created_by: "{{ created_by }}"
      filters:
        - 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 }}"
      id: "{{ id }}"
      linked_listings:
        - created_at: {{ created_at }}
          created_by: "{{ created_by }}"
          exchange_id: "{{ exchange_id }}"
          exchange_name: "{{ exchange_name }}"
          id: "{{ id }}"
          listing_id: "{{ listing_id }}"
          listing_name: "{{ listing_name }}"
      updated_at: {{ updated_at }}
      updated_by: "{{ updated_by }}"

REPLACE examples

update

Update an exchange

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

DELETE examples

delete

This removes a listing from marketplace.

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