user_* server settings

These settings configure the ClickHouse server and are autogenerated from ClickHouse source.

user_directories

Section of the configuration file that contains settings:

Path to configuration file with predefined users.
Path to folder where users created by SQL commands are stored.
ZooKeeper node path where users created by SQL commands are stored and replicated.

If this section is specified, the path from users_config and access_control_path won’t be used. The user_directories section can contain any number of items, the order of the items means their precedence (the higher the item the higher the precedence). Examples

<user_directories>
    <users_xml>
        <path>/etc/clickhouse-server/users.xml</path>
    </users_xml>
    <local_directory>
        <path>/var/lib/clickhouse/access/</path>
    </local_directory>
</user_directories>

Users, roles, row policies, quotas, and profiles can be also stored in ZooKeeper:

<user_directories>
    <users_xml>
        <path>/etc/clickhouse-server/users.xml</path>
    </users_xml>
    <replicated>
        <zookeeper_path>/clickhouse/access/</zookeeper_path>
    </replicated>
</user_directories>

You can also define sections memory — means storing information only in memory, without writing to disk, and ldap — means storing information on an LDAP server. To add an LDAP server as a remote user directory of users that are not defined locally, define a single ldap section with the following settings:

Setting	Description
`roles`	section with a list of locally defined roles that will be assigned to each user retrieved from the LDAP server. If no roles are specified, user will not be able to perform any actions after authentication. If any of the listed roles is not defined locally at the time of authentication, the authentication attempt will fail as if the provided password was incorrect.
`server`	one of LDAP server names defined in `ldap_servers` config section. This parameter is mandatory and cannot be empty.

Example

<ldap>
    <server>my_ldap_server</server>
        <roles>
            <my_local_role1 />
            <my_local_role2 />
        </roles>
</ldap>

user_files_path

The directory with user files. Used in the table function file(), fileCluster(). Example

<user_files_path>/var/lib/clickhouse/user_files/</user_files_path>

user_profile_events_per_cpu

Shard per-user ProfileEvents counters per CPU to avoid cross-CPU cache-line contention under high thread counts. Each user pays getNumCPUs() * num_events * sizeof(atomic) of memory (hundreds of KiB on machines with many cores). Disable to fall back to a single shared atomic per event per user, trading throughput for memory.

user_scripts_path

The directory with user scripts files. Used for Executable user defined functions Executable User Defined Functions. Example

<user_scripts_path>/var/lib/clickhouse/user_scripts/</user_scripts_path>

SQL Reference

Data Types

Engines

Functions

Formats

Interfaces

Settings

System Tables

Data Lakes

user_directories

user_files_path

user_profile_events_per_cpu

user_scripts_path

​user_directories

​user_files_path

​user_profile_events_per_cpu

​user_scripts_path

user_directories

user_files_path

user_profile_events_per_cpu

user_scripts_path