consumer_installations

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

Overview

Name	consumer_installations
Type	Resource
Id	databricks_workspace.marketplace.consumer_installations

Fields

The following fields are returned by SELECT queries:

list

Request completed successfully.

Name	Datatype	Description
id	string
listing_id	string
catalog_name	string
listing_name	string
repo_name	string
share_name	string
error_message	string
installed_on	integer
recipient_type	string
repo_path	string
status	string
token_detail	object
tokens	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name		List all installations across all listings.
create	insert	deployment_name		Install payload associated with a Databricks Marketplace listing.
update	update	deployment_name		This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table
delete	delete	deployment_name		Uninstall an installation associated with a Databricks Marketplace 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 (default: dbc-abcd0123-a1bc)

SELECT examples

list

List all installations across all listings.

SELECT
id,
listing_id,
catalog_name,
listing_name,
repo_name,
share_name,
error_message,
installed_on,
recipient_type,
repo_path,
status,
token_detail,
tokens
FROM databricks_workspace.marketplace.consumer_installations
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Install payload associated with a Databricks Marketplace listing.

INSERT INTO databricks_workspace.marketplace.consumer_installations (
data__share_name,
data__catalog_name,
data__recipient_type,
data__repo_detail,
data__accepted_consumer_terms,
deployment_name
)
SELECT 
'{{ share_name }}',
'{{ catalog_name }}',
'{{ recipient_type }}',
'{{ repo_detail }}',
'{{ accepted_consumer_terms }}',
'{{ deployment_name }}'
RETURNING
installation
;

Manifest

# Description fields are for documentation purposes
- name: consumer_installations
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the consumer_installations resource.
    - name: share_name
      value: string
    - name: catalog_name
      value: string
    - name: recipient_type
      value: string
    - name: repo_detail
      value: object
    - name: accepted_consumer_terms
      value: object

UPDATE examples

update

This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table

UPDATE databricks_workspace.marketplace.consumer_installations
SET 
data__rotate_token = {{ rotate_token }},
data__installation = '{{ installation }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
installation;

DELETE examples

delete

Uninstall an installation associated with a Databricks Marketplace listing.

DELETE FROM databricks_workspace.marketplace.consumer_installations
WHERE deployment_name = '{{ deployment_name }}' --required;