Перейти к основному содержанию
Перейти к основному содержанию

Интерфейс PostgreSQL

Not supported in ClickHouse Cloud

ClickHouse поддерживает сетевой протокол PostgreSQL (PostgreSQL wire protocol), что позволяет использовать клиенты PostgreSQL для подключения к ClickHouse. В некотором смысле ClickHouse может выдавать себя за экземпляр PostgreSQL, позволяя подключать к ClickHouse клиентские приложения PostgreSQL, которые ещё не поддерживаются ClickHouse напрямую (например, Amazon Redshift).

Чтобы включить сетевой протокол PostgreSQL, добавьте настройку postgresql_port в конфигурационный файл сервера. Например, вы можете определить этот порт в новом XML‑файле в папке config.d:

<clickhouse>
    <postgresql_port>9005</postgresql_port>
</clickhouse>

Запустите сервер ClickHouse и найдите в его журнале сообщение, похожее на следующее и содержащее фразу Listening for PostgreSQL compatibility protocol:

{} <Information> Application: Listening for PostgreSQL compatibility protocol: 127.0.0.1:9005

Подключение psql к ClickHouse​

Следующая команда показывает, как подключить клиент PostgreSQL psql к ClickHouse:

psql -p [port] -h [hostname] -U [username] [database_name]

Например:

psql -p 9005 -h 127.0.0.1 -U alice default
Примечание

Клиент psql требует входа с использованием пароля, поэтому вы не сможете подключиться, используя пользователя default без пароля. Либо задайте пароль пользователю default, либо войдите под учетной записью другого пользователя.

Клиент psql запрашивает пароль:

Password for user alice:
psql (14.2, server 22.3.1.1)
WARNING: psql major version 14, server major version 22.
         Some psql features might not work.
Type "help" for help.

default=>

Вот и всё! Теперь у вас есть клиент PostgreSQL, подключённый к ClickHouse, и все команды и запросы выполняются в ClickHouse.

Примечание

Протокол PostgreSQL в настоящий момент поддерживает только пароли в виде открытого текста.

Использование SSL​

Если в экземпляре ClickHouse у вас настроен SSL/TLS, то postgresql_port будет использовать те же настройки (порт общий для защищённых и незащищённых клиентов).

У каждого клиента свой способ подключения с использованием SSL. Следующая команда показывает, как передать сертификаты и ключ для безопасного подключения psql к ClickHouse:

psql "port=9005 host=127.0.0.1 user=alice dbname=default sslcert=/path/to/certificate.pem sslkey=/path/to/key.pem sslrootcert=/path/to/rootcert.pem sslmode=verify-ca"

Настройка аутентификации пользователей ClickHouse с использованием SCRAM-SHA-256​

Чтобы обеспечить безопасную аутентификацию пользователей в ClickHouse, рекомендуется использовать протокол SCRAM-SHA-256. Настройте пользователя, указав элемент password_scram_sha256_hex в файле users.xml. Хеш пароля должен быть сгенерирован с числом итераций num_iterations=4096.

Убедитесь, что клиент psql поддерживает SCRAM-SHA-256 и использует его при установлении соединения.

Пример конфигурации для пользователя user_with_sha256 с паролем abacaba:

<user_with_sha256>
    <password_scram_sha256_hex>04e7a70338d7af7bb6142fe7e19fef46d9b605f3e78b932a60e8200ef9154976</password_scram_sha256_hex>
</user_with_sha256>

Подробнее о параметрах SSL см. в документации PostgreSQL.