consumer_listings

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

Overview

Name	consumer_listings
Type	Resource
Id	databricks_workspace.marketplace.consumer_listings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶listing	object

list

Name	Datatype	Description
id	string
▶detail	object
▶summary	object

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 a published listing in the Databricks Marketplace that the consumer has access to.
list	select	deployment_name, workspace_domain	assets, categories, is_free, is_private_exchange, is_staff_pick, page_size, page_token, provider_ids, tags	List all published listings in the Databricks Marketplace that the consumer has access to.
batch_get	exec	deployment_name, workspace_domain	ids	Batch get a published listing in the Databricks Marketplace that the consumer has access to.
search	exec	query, deployment_name, workspace_domain	assets, categories, is_free, is_private_exchange, page_size, page_token, provider_ids	Search published listings in the Databricks Marketplace that the consumer has access to. This query

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
query	string	Fuzzy matches query
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"}})
assets	array	Matches any of the following asset types
categories	array	Matches any of the following categories
ids	array
is_free	boolean
is_private_exchange	boolean
is_staff_pick	boolean	Filters each listing based on whether it is a staff pick.
page_size	integer
page_token	string
provider_ids	array	Matches any of the following provider ids
tags	object	Matches listings with this tag

SELECT examples

get

Get a published listing in the Databricks Marketplace that the consumer has access to.

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

list

List all published listings in the Databricks Marketplace that the consumer has access to.

SELECT
id,
detail,
summary
FROM databricks_workspace.marketplace.consumer_listings
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND assets = '{{ assets }}'
AND categories = '{{ categories }}'
AND is_free = '{{ is_free }}'
AND is_private_exchange = '{{ is_private_exchange }}'
AND is_staff_pick = '{{ is_staff_pick }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
AND provider_ids = '{{ provider_ids }}'
AND tags = '{{ tags }}'
;

Lifecycle Methods

batch_get

Batch get a published listing in the Databricks Marketplace that the consumer has access to.

EXEC databricks_workspace.marketplace.consumer_listings.batch_get 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required, 
@ids='{{ ids }}'
;

search

Search published listings in the Databricks Marketplace that the consumer has access to. This query

EXEC databricks_workspace.marketplace.consumer_listings.search 
@query='{{ query }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required, 
@assets='{{ assets }}', 
@categories='{{ categories }}', 
@is_free={{ is_free }}, 
@is_private_exchange={{ is_private_exchange }}, 
@page_size='{{ page_size }}', 
@page_token='{{ page_token }}', 
@provider_ids='{{ provider_ids }}'
;