Skip to main content

account_user_preferences_metadata

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

Overview

Nameaccount_user_preferences_metadata
TypeResource
Iddatabricks_account.settingsv2.account_user_preferences_metadata

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringName of the setting.
descriptionstring
docs_linkstringLink to databricks documentation for the setting
typestringSample message depicting the type of the setting. To set this setting, the value sent must match this type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_account_user_preferences_metadataselectaccount_id, user_idpage_size, page_tokenList valid user preferences and their metadata for a specific user. User preferences are personal

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.

NameDatatypeDescription
account_idstring
user_idstringUser ID of the user whose settings metadata is being retrieved.
page_sizeintegerThe maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 200 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_tokenstringA page token, received from a previous ListAccountUserPreferencesMetadataRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccountUserPreferencesMetadataRequest must match the call that provided the page token.

SELECT examples

List valid user preferences and their metadata for a specific user. User preferences are personal

SELECT
name,
description,
docs_link,
type
FROM databricks_account.settingsv2.account_user_preferences_metadata
WHERE account_id = '{{ account_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;