跳到主要内容
跳到主要内容

PostgreSQL 接口

Not supported in ClickHouse Cloud

ClickHouse 支持 PostgreSQL 线协议，这使您可以使用 PostgreSQL 客户端连接到 ClickHouse。从某种意义上说，ClickHouse 可以充当一个 PostgreSQL 实例——从而允许您将 PostgreSQL 客户端应用程序连接到 ClickHouse，即便该应用程序尚未被 ClickHouse 直接支持（例如 Amazon Redshift）。

要启用 PostgreSQL 线协议，请在服务器的配置文件中添加 postgresql_port 设置。例如，您可以在 config.d 文件夹中新建一个 XML 文件来定义该端口：

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

启动 ClickHouse 服务器，并在日志中查找类似如下的信息，其中包含 Listening for PostgreSQL compatibility protocol：

{} <Information> 应用程序：监听 PostgreSQL 兼容协议：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 客户端会提示输入密码：

用户 alice 的密码：
psql（14.2，服务器 22.3.1.1）
警告：psql 主版本号为 14，服务器主版本号为 22。
         某些 psql 功能可能无法使用。
输入 "help" 获取帮助。

default=>

就完成了！你现在已经有一个已连接到 ClickHouse 的 PostgreSQL 客户端，所有命令和查询都会在 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"

使用 SCRAM-SHA-256 配置 ClickHouse 用户认证​

为确保 ClickHouse 用户认证的安全性，推荐使用 SCRAM-SHA-256 协议。可通过在 users.xml 文件中指定 password_scram_sha256_hex 元素来配置用户。密码哈希必须在生成时使用 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 文档。