account_user_preferences

Creates, updates, deletes, gets or lists an account_user_preferences resource.

Overview

Name	account_user_preferences
Type	Resource
Id	databricks_account.settingsv2.account_user_preferences

Fields

The following fields are returned by SELECT queries:

get_public_account_user_preference

Name	Datatype	Description
name	string	Name of the setting.
user_id	string	User ID of the user.
▶boolean_val	object
▶effective_boolean_val	object
▶effective_string_val	object
▶string_val	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_public_account_user_preference	select	account_id, user_id, name, account_host		Get a user preference for a specific user. User preferences are personal settings that allow
patch_public_account_user_preference	update	account_id, user_id, name, account_host		Update a user preference for a specific user. User preferences are personal settings that allow

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
account_host	string	The Databricks account console host. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws), or set explicitly with DATABRICKS_ACCOUNT_HOST (bare host, no scheme). (default: accounts.cloud.databricks.com, x-stackQL-envVar: DATABRICKS_ACCOUNT_HOST, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"accounts.cloud.databricks.com","azure":"accounts.azuredatabricks.net","gcp":"accounts.gcp.databricks.com"}})
account_id	string
name	string
user_id	string	User ID of the user whose setting is being updated.

SELECT examples

get_public_account_user_preference

Get a user preference for a specific user. User preferences are personal settings that allow

SELECT
name,
user_id,
boolean_val,
effective_boolean_val,
effective_string_val,
string_val
FROM databricks_account.settingsv2.account_user_preferences
WHERE account_id = '{{ account_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND name = '{{ name }}' -- required
AND account_host = '{{ account_host }}' -- required
;

UPDATE examples

patch_public_account_user_preference

Update a user preference for a specific user. User preferences are personal settings that allow

UPDATE databricks_account.settingsv2.account_user_preferences
SET 
boolean_val = '{{ boolean_val }}',
effective_boolean_val = '{{ effective_boolean_val }}',
effective_string_val = '{{ effective_string_val }}',
name = '{{ name }}',
string_val = '{{ string_val }}',
user_id = '{{ user_id }}'
WHERE 
account_id = '{{ account_id }}' --required
AND user_id = '{{ user_id }}' --required
AND name = '{{ name }}' --required
AND account_host = '{{ account_host }}' --required
RETURNING
name,
user_id,
boolean_val,
effective_boolean_val,
effective_string_val,
string_val;