provider_listings

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

Overview

Name	provider_listings
Type	Resource
Id	databricks_workspace.marketplace.provider_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 listing
list	select	deployment_name, workspace_domain	page_size, page_token	List listings owned by this provider
create	insert	deployment_name, workspace_domain, listing		Create a new listing
update	replace	id, deployment_name, workspace_domain, listing		Update a listing
delete	delete	id, deployment_name, workspace_domain		Delete a listing

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 a listing

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

list

List listings owned by this provider

SELECT
id,
detail,
summary
FROM databricks_workspace.marketplace.provider_listings
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 a new listing

INSERT INTO databricks_workspace.marketplace.provider_listings (
listing,
deployment_name,
workspace_domain
)
SELECT 
'{{ listing }}' /* required */,
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
listing_id
;

Manifest

# Description fields are for documentation purposes
- name: provider_listings
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the provider_listings resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the provider_listings resource.
  - name: listing
    value:
      summary:
        name: "{{ name }}"
        listingType: "{{ listingType }}"
        categories:
          - "{{ categories }}"
        created_at: {{ created_at }}
        created_by: "{{ created_by }}"
        created_by_id: {{ created_by_id }}
        exchange_ids:
          - "{{ exchange_ids }}"
        git_repo:
          git_repo_url: "{{ git_repo_url }}"
        provider_id: "{{ provider_id }}"
        provider_region:
          cloud: "{{ cloud }}"
          region: "{{ region }}"
        published_at: {{ published_at }}
        published_by: "{{ published_by }}"
        setting:
          visibility: "{{ visibility }}"
        share:
          name: "{{ name }}"
          type: "{{ type }}"
        status: "{{ status }}"
        subtitle: "{{ subtitle }}"
        updated_at: {{ updated_at }}
        updated_by: "{{ updated_by }}"
        updated_by_id: {{ updated_by_id }}
      detail:
        assets:
          - "{{ assets }}"
        collection_date_end: {{ collection_date_end }}
        collection_date_start: {{ collection_date_start }}
        collection_granularity:
          interval: {{ interval }}
          unit: "{{ unit }}"
        cost: "{{ cost }}"
        data_source: "{{ data_source }}"
        description: "{{ description }}"
        documentation_link: "{{ documentation_link }}"
        embedded_notebook_file_infos:
          - created_at: {{ created_at }}
            display_name: "{{ display_name }}"
            download_link: "{{ download_link }}"
            file_parent:
              file_parent_type: "{{ file_parent_type }}"
              parent_id: "{{ parent_id }}"
            id: "{{ id }}"
            marketplace_file_type: "{{ marketplace_file_type }}"
            mime_type: "{{ mime_type }}"
            status: "{{ status }}"
            status_message: "{{ status_message }}"
            updated_at: {{ updated_at }}
        file_ids:
          - "{{ file_ids }}"
        geographical_coverage: "{{ geographical_coverage }}"
        license: "{{ license }}"
        pricing_model: "{{ pricing_model }}"
        privacy_policy_link: "{{ privacy_policy_link }}"
        size: {{ size }}
        support_link: "{{ support_link }}"
        tags:
          - tag_name: "{{ tag_name }}"
            tag_values: "{{ tag_values }}"
        terms_of_service: "{{ terms_of_service }}"
        update_frequency:
          interval: {{ interval }}
          unit: "{{ unit }}"
      id: "{{ id }}"

REPLACE examples

update

Update a listing

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

DELETE examples

delete

Delete a listing

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