Configuring Profiles

Setting up profiles for groups of ClickHouse® users

Profiles allow you to give a name to a group of user settings, then easily apply those settings to users of your ClickHouse® cluster. Click the Profiles menu to get started:

The Profiles dialog

Figure 1 - The Profiles dialog

Creating or editing a profile’s name and description

Clicking the add profile button button takes you to the Profile Details dialog:

The Profile Details dialog

Figure 2 - The Profile Details dialog

Give the new profile a name and description, then click OK to create the new profile.

From the profile list shown in Figure 1 you can also click the vertical dots icon icon next to a profile name, then select Edit to change its name and description:

The Edit Profile menu

Figure 3 - The Edit Profile menu

This takes you to the dialog shown in Figure 2 above.

Editing a profile’s settings

To edit the actual settings in the profile, click the Edit Settings link in the right side of the list of profiles shown in Figure 1. You’ll see a list of everything in this profile:

The list of profile settings

Figure 4 - The list of profile settings

There are currently more than 1500 settings. You can click the filter icon to enter a search term:

Filtering the list of settings

Figure 5 - Filtering the list of settings

Here we’re filtering the list of settings to only those with experimental in their names. You can also click the Name title to list parameters in ascending or descending order.

Clicking the add setting button button takes you to the Profile Setting Details dialog:

The Profile Setting Details dialog

Figure 6 - The Profile Setting Details dialog

Clicking the down arrow icon down arrow displays a drop-down menu that lists all the settings. You can also start typing the name of a setting to avoid scrolling through the entire list. Selecting any setting in the list updates the dialog with a hint for that setting.

To change an existing setting, click the vertical dots icon icon, then select Edit from the menu:

Editing an existing setting

Figure 7 - Editing an existing setting

This takes you to the dialog shown in Figure 6 above.

Selecting which profile to edit

You can switch to another profile while in edit mode. Clicking the change profile button button displays a dropdown list of all your profiles:

The Select Profile menu

Figure 8 - Selecting a profile to edit

Other editing tasks

You can also click the show changes only slider slider to see only the settings you’ve changed or click the reset to defaults button to reset all settings to their defaults. If you click that, you’ll be asked to confirm your choice:

Configuring profile reset dialog

Figure 9 - Configuring profile reset

Deleting a profile

From the profiles list you can also click the vertical dots icon icon and select Delete from the menu:

Delete profile menu

You’ll be asked to confirm:

The Delete Profile dialog

Figure 10 - The Delete Profile dialog