v.22.12Experimental Feature

Add CREATE/ALTER/DROP NAMED COLLECTION Queries and Introduce system.named_collections Table

Official CH changelog text
Add CREATE / ALTER / DROP NAMED COLLECTION queries. #43252 (Kseniia Sumarokova). This feature is under development and the queries are not effective as of version 22.12. This changelog entry is added only to avoid confusion. Restrict default access to named collections to the user defined in config. This requires that show_named_collections = 1 is set to be able to see them. #43325 (Kseniia Sumarokova). The system.named_collections table is introduced #43147 (Kseniia Sumarokova).
Introduced CREATE, ALTER, and DROP NAMED COLLECTION queries, enabling the management of named collections in ClickHouse, along with the system.named_collections table to view these collections.

Why it matters

This feature allows users to define, modify, and remove named collections, which helps organize and reuse sets of configuration or parameters. It enhances security by restricting default access to named collections only to the configured user, improving control and visibility of these objects.

How to use it

To use this feature, enable access to named collections by setting show_named_collections = 1 in the configuration. Then, manage named collections via the new SQL queries:

CREATE NAMED COLLECTION ...
ALTER NAMED COLLECTION ...
DROP NAMED COLLECTION ...


You can view all existing named collections by querying the system.named_collections table.

Related resources

PreviousNext