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_for_listing
list

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`	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />>>> class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> >>> Color.RED<br /> <Color.RED: 1><br /><br />- value lookup:<br /><br /> >>> Color(1)<br /> <Color.RED: 1><br /><br />- name lookup:<br /><br /> >>> Color['RED']<br /> <Color.RED: 1><br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />>>> len(Color)<br />3<br /><br />>>> list(Color)<br />[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN)
`repo_path`	`string`
`status`	`string`	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />>>> class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> >>> Color.RED<br /> <Color.RED: 1><br /><br />- value lookup:<br /><br /> >>> Color(1)<br /> <Color.RED: 1><br /><br />- name lookup:<br /><br /> >>> Color['RED']<br /> <Color.RED: 1><br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />>>> len(Color)<br />3<br /><br />>>> list(Color)<br />[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (FAILED, INSTALLED)
▶`token_detail`	`object`
▶`tokens`	`array`

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`	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />>>> class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> >>> Color.RED<br /> <Color.RED: 1><br /><br />- value lookup:<br /><br /> >>> Color(1)<br /> <Color.RED: 1><br /><br />- name lookup:<br /><br /> >>> Color['RED']<br /> <Color.RED: 1><br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />>>> len(Color)<br />3<br /><br />>>> list(Color)<br />[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS, DELTA_SHARING_RECIPIENT_TYPE_OPEN)
`repo_path`	`string`
`status`	`string`	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />>>> class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> >>> Color.RED<br /> <Color.RED: 1><br /><br />- value lookup:<br /><br /> >>> Color(1)<br /> <Color.RED: 1><br /><br />- name lookup:<br /><br /> >>> Color['RED']<br /> <Color.RED: 1><br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />>>> len(Color)<br />3<br /><br />>>> list(Color)<br />[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (FAILED, INSTALLED)
▶`token_detail`	`object`
▶`tokens`	`array`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`list_for_listing`	`select`	`listing_id`, `deployment_name`, `workspace_domain`	`page_size`, `page_token`	List all installations for a particular listing.
`list`	`select`	`deployment_name`, `workspace_domain`	`page_size`, `page_token`	List all installations across all listings.
`create`	`insert`	`listing_id`, `deployment_name`, `workspace_domain`		Install payload associated with a Databricks Marketplace listing.
`update`	`replace`	`listing_id`, `installation_id`, `deployment_name`, `workspace_domain`, `installation`		This is a update API that will update the part of the fields defined in the installation table as well
`delete`	`delete`	`listing_id`, `installation_id`, `deployment_name`, `workspace_domain`		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: 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)
`installation_id`	`string`
`listing_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_for_listing
list

List all installations for a particular listing.

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 listing_id = '{{ listing_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

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
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

`INSERT` examples

create
Manifest

Install payload associated with a Databricks Marketplace listing.

INSERT INTO databricks_workspace.marketplace.consumer_installations (
accepted_consumer_terms,
catalog_name,
recipient_type,
repo_detail,
share_name,
listing_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ accepted_consumer_terms }}',
'{{ catalog_name }}',
'{{ recipient_type }}',
'{{ repo_detail }}',
'{{ share_name }}',
'{{ listing_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
installation
;

# Description fields are for documentation purposes
- name: consumer_installations
props:
  - name: listing_id
    value: "{{ listing_id }}"
    description: Required parameter for the consumer_installations resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the consumer_installations resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the consumer_installations resource.
  - name: accepted_consumer_terms
    value:
      version: "{{ version }}"
  - name: catalog_name
    value: "{{ catalog_name }}"
  - name: recipient_type
    value: "{{ recipient_type }}"
    description: |
      Create a collection of name/value pairs.
      Example enumeration:
      >>> class Color(Enum):
      ...     RED = 1
      ...     BLUE = 2
      ...     GREEN = 3
      Access them by:
      - attribute access:
      >>> Color.RED
      <Color.RED: 1>
      - value lookup:
      >>> Color(1)
      <Color.RED: 1>
      - name lookup:
      >>> Color['RED']
      <Color.RED: 1>
      Enumerations can be iterated over, and know how many members they have:
      >>> len(Color)
      3
      >>> list(Color)
      [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
      Methods can be added to enumerations, and members can have their own
      attributes -- see the documentation for details.
  - name: repo_detail
    description: |
      for git repo installations
    value:
      repo_name: "{{ repo_name }}"
      repo_path: "{{ repo_path }}"
  - name: share_name
    value: "{{ share_name }}"

`REPLACE` examples

update

This is a update API that will update the part of the fields defined in the installation table as well

REPLACE databricks_workspace.marketplace.consumer_installations
SET 
installation = '{{ installation }}',
rotate_token = {{ rotate_token }}
WHERE 
listing_id = '{{ listing_id }}' --required
AND installation_id = '{{ installation_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
AND installation = '{{ installation }}' --required
RETURNING
installation;

`DELETE` examples

delete

Uninstall an installation associated with a Databricks Marketplace listing.

DELETE FROM databricks_workspace.marketplace.consumer_installations
WHERE listing_id = '{{ listing_id }}' --required
AND installation_id = '{{ installation_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​