consumer_personalization_requests

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

Overview

Name	consumer_personalization_requests
Type	Resource
Id	databricks_workspace.marketplace.consumer_personalization_requests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶personalization_requests	array

list

Name	Datatype	Description
id	string
listing_id	string
metastore_id	string
provider_id	string
listing_name	string
comment	string
▶consumer_region	object
▶contact_info	object	contact info for the consumer requesting data or performing a listing installation
created_at	integer
intended_use	string
is_from_lighthouse	boolean
recipient_type	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> &gt;&gt;&gt; Color.RED<br /> &lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br /> &gt;&gt;&gt; Color(1)<br /> &lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br /> &gt;&gt;&gt; Color['RED']<br /> &lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<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)
▶share	object	Share information is required for data listings but should be empty/ignored for non-data listings (MCP and App).
status	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access:<br /><br /> &gt;&gt;&gt; Color.RED<br /> &lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br /> &gt;&gt;&gt; Color(1)<br /> &lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br /> &gt;&gt;&gt; Color['RED']<br /> &lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (DENIED, FULFILLED, NEW, REQUEST_PENDING)
status_message	string
updated_at	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	listing_id, deployment_name, workspace_domain		Get the personalization request for a listing. Each consumer can make at most one personalization
list	select	deployment_name, workspace_domain	page_size, page_token	List personalization requests for a consumer across all listings.
create	insert	listing_id, deployment_name, workspace_domain, intended_use, accepted_consumer_terms		Create a personalization request for 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)
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

get

Get the personalization request for a listing. Each consumer can make at most one personalization

SELECT
personalization_requests
FROM databricks_workspace.marketplace.consumer_personalization_requests
WHERE listing_id = '{{ listing_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

List personalization requests for a consumer across all listings.

SELECT
id,
listing_id,
metastore_id,
provider_id,
listing_name,
comment,
consumer_region,
contact_info,
created_at,
intended_use,
is_from_lighthouse,
recipient_type,
share,
status,
status_message,
updated_at
FROM databricks_workspace.marketplace.consumer_personalization_requests
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 personalization request for a listing.

INSERT INTO databricks_workspace.marketplace.consumer_personalization_requests (
intended_use,
accepted_consumer_terms,
comment,
company,
first_name,
is_from_lighthouse,
last_name,
recipient_type,
listing_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ intended_use }}' /* required */,
'{{ accepted_consumer_terms }}' /* required */,
'{{ comment }}',
'{{ company }}',
'{{ first_name }}',
{{ is_from_lighthouse }},
'{{ last_name }}',
'{{ recipient_type }}',
'{{ listing_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: consumer_personalization_requests
props:
  - name: listing_id
    value: "{{ listing_id }}"
    description: Required parameter for the consumer_personalization_requests resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the consumer_personalization_requests resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the consumer_personalization_requests resource.
  - name: intended_use
    value: "{{ intended_use }}"
  - name: accepted_consumer_terms
    value:
      version: "{{ version }}"
  - name: comment
    value: "{{ comment }}"
  - name: company
    value: "{{ company }}"
  - name: first_name
    value: "{{ first_name }}"
  - name: is_from_lighthouse
    value: {{ is_from_lighthouse }}
  - name: last_name
    value: "{{ last_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.