Движок таблицы PostgreSQL - ClickHouse Documentation

Движок PostgreSQL позволяет выполнять запросы SELECT и INSERT к данным, хранящимся на удалённом сервере PostgreSQL.

В настоящее время движок таблицы поддерживает только PostgreSQL версии 12 и выше.

Ознакомьтесь с нашим сервисом Managed Postgres. Благодаря NVMe-хранилищу, физически размещённому рядом с вычислительными ресурсами, он обеспечивает до 10 раз более высокую производительность для рабочих нагрузок, ограниченных скоростью диска, по сравнению с альтернативами, использующими сетевые хранилища, такие как EBS, а также позволяет реплицировать данные из Postgres в ClickHouse с помощью коннектора Postgres CDC в ClickPipes.

Создание таблицы

CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
    name1 type1 [DEFAULT|MATERIALIZED|ALIAS expr1],
    name2 type2 [DEFAULT|MATERIALIZED|ALIAS expr2],
    ...
) ENGINE = PostgreSQL({host:port, database, table, user, password[, schema, [, on_conflict]] | named_collection[, option=value [,..]]})
SETTINGS
    [ postgresql_connection_pool_size=16, ]
    [ postgresql_connection_pool_wait_timeout=5000, ]
    [ postgresql_connection_pool_retries=2, ]
    [ postgresql_connection_pool_auto_close_connection=false, ]
    [ postgresql_connection_attempt_timeout=2 ]
;

См. подробное описание запроса CREATE TABLE. Структура таблицы может отличаться от структуры исходной таблицы PostgreSQL:

Имена столбцов должны совпадать с именами в исходной таблице PostgreSQL, но можно использовать только часть этих столбцов и в любом порядке.
Типы столбцов могут отличаться от типов в исходной таблице PostgreSQL. ClickHouse пытается преобразовывать значения в типы данных ClickHouse.
Настройка external_table_functions_use_nulls определяет, как обрабатывать столбцы с типом Nullable. Значение по умолчанию: 1. Если указано 0, табличная функция не создаёт столбцы с типом Nullable и вставляет значения по умолчанию вместо null. Это также применимо к значениям NULL внутри массивов.

Параметры движка

host:port — адрес сервера PostgreSQL.
database — имя удалённой базы данных.
table — имя удалённой таблицы или запрос, передаваемый в PostgreSQL как есть (см. Передача запроса вместо имени таблицы).
user — пользователь PostgreSQL.
password — пароль пользователя.
schema — схема таблицы, отличная от используемой по умолчанию. Необязательно.
on_conflict — стратегия разрешения конфликтов. Пример: ON CONFLICT DO NOTHING. Необязательно. Примечание: добавление этой опции сделает вставку менее эффективной.

Именованные коллекции (доступны начиная с версии 21.11) рекомендуются для продакшн-окружения. Вот пример:

<named_collections>
    <postgres_creds>
        <host>localhost</host>
        <port>5432</port>
        <user>postgres</user>
        <password>****</password>
        <schema>schema1</schema>
    </postgres_creds>
</named_collections>

Некоторые параметры можно переопределить аргументами key-value:

SELECT * FROM postgresql(postgres_creds, table='table1');

Настройки

Пул соединений, используемый движком таблицы PostgreSQL (и табличной функцией postgresql), можно настроить для каждой таблицы с помощью предложения SETTINGS. Если настройка не указана, по умолчанию используется значение соответствующей настройки postgresql_* на уровне запроса.

`postgresql_connection_pool_size`

Размер пула соединений (если все соединения заняты, запрос ожидает, пока одно из них не освободится). Значение должно быть ненулевым. Значение по умолчанию: 16.

`postgresql_connection_pool_wait_timeout`

Тайм-аут операций push/pop в пуле соединений в миллисекундах, если пул пуст. 0 означает блокировку при пустом пуле. Значение по умолчанию: 5000.

`postgresql_connection_pool_retries`

Число повторных попыток операций push/pop в пуле соединений. Значение по умолчанию: 2.

`postgresql_connection_pool_auto_close_connection`

Закрывать соединение перед возвратом в пул. Значение по умолчанию: false.

`postgresql_connection_attempt_timeout`

Тайм-аут подключения в секундах для одной попытки соединения с конечной точкой PostgreSQL. Значение передаётся как параметр connect_timeout в URL подключения. Значение по умолчанию: 2. Пример:

CREATE TABLE pg_table
(
    `float_nullable` Nullable(Float32),
    `str` String,
    `int_id` Int32
)
ENGINE = PostgreSQL('localhost:5432', 'public', 'test', 'postgres_user', 'postgres_password')
SETTINGS postgresql_connection_pool_size = 32, postgresql_connection_pool_auto_close_connection = 1;

Подробности реализации

SELECT-запросы на стороне PostgreSQL выполняются как COPY (SELECT ...) TO STDOUT внутри PostgreSQL-транзакции в режиме только для чтения, с коммитом после каждого SELECT-запроса. Простые предложения WHERE, такие как =, !=, >, >=, <, <= и IN, выполняются на сервере PostgreSQL. Все JOIN, агрегации, сортировка, условия IN [ array ] и ограничение сэмплирования LIMIT выполняются в ClickHouse только после завершения запроса к PostgreSQL.

Передача запроса вместо имени таблицы

Вместо имени таблицы аргумент table может содержать SELECT-запрос, который передаётся в PostgreSQL как есть. Структура таблицы определяется по результату запроса. Запрос можно записать либо как подзапрос, либо обернуть в функцию query:

CREATE TABLE pg_table ENGINE = PostgreSQL('localhost:5432', 'test', (SELECT a, b FROM t1 JOIN t2 USING (id) WHERE a > 0), 'user', 'password');
CREATE TABLE pg_table ENGINE = PostgreSQL('localhost:5432', 'test', query('SELECT a, b FROM t1 JOIN t2 USING (id) WHERE a > 0'), 'user', 'password');

Это полезно, чтобы проталкивать JOIN, агрегации или любую другую обработку в PostgreSQL. Такая таблица доступна только для чтения: INSERT в неё не допускается. Тот же синтаксис поддерживается табличной функцией postgresql.

Форма подзапроса (SELECT ...) разбирается ClickHouse и повторно сериализуется в диалекте PostgreSQL (экранирование идентификаторов PostgreSQL и строковых литералов) перед отправкой на сервер. Поэтому она должна быть корректным ClickHouse SQL. Чтобы передать синтаксис, специфичный для PostgreSQL, который ClickHouse не разбирает, используйте форму query('...'), текст которой отправляется в PostgreSQL дословно.Любой внешний WHERE, LIMIT, агрегация и т. д. из окружающего запроса ClickHouse не проталкиваются в переданный запрос — они применяются в ClickHouse после получения полного результата запроса. Чтобы ограничить данные, читаемые из PostgreSQL, поместите фильтр внутрь переданного запроса. При external_table_strict_query = 1 внешний фильтр, который нельзя протолкнуть, отклоняется с исключением вместо локального применения.

INSERT-запросы на стороне PostgreSQL выполняются как COPY "table_name" (field1, field2, ... fieldN) FROM STDIN внутри PostgreSQL-транзакции с автокоммитом после каждого оператора INSERT. Типы Array в PostgreSQL преобразуются в массивы ClickHouse.

Будьте внимательны: в PostgreSQL массив, созданный как type_name[], может содержать многомерные массивы с разным количеством измерений в разных строках одного и того же столбца таблицы. В ClickHouse же допускаются только многомерные массивы с одинаковым количеством измерений во всех строках одного и того же столбца.

Поддерживается несколько реплик, которые должны быть перечислены через |. Например:

CREATE TABLE test_replicas (id UInt32, name String) ENGINE = PostgreSQL(`postgres{2|3|4}:5432`, 'clickhouse', 'test_replicas', 'postgres', 'mysecretpassword');

Поддерживается задание приоритета реплик для источника словаря PostgreSQL. Чем больше число в map, тем ниже приоритет. Наивысший приоритет — 0. В примере ниже у реплики example01-1 наивысший приоритет:

<postgresql>
    <port>5432</port>
    <user>clickhouse</user>
    <password>qwerty</password>
    <replica>
        <host>example01-1</host>
        <priority>1</priority>
    </replica>
    <replica>
        <host>example01-2</host>
        <priority>2</priority>
    </replica>
    <db>db_name</db>
    <table>table_name</table>
    <where>id=10</where>
    <invalidate_query>SQL_QUERY</invalidate_query>
</postgresql>
</source>

Пример использования

Таблица в PostgreSQL

postgres=# CREATE TABLE "public"."test" (
"int_id" SERIAL,
"int_nullable" INT NULL DEFAULT NULL,
"float" FLOAT NOT NULL,
"str" VARCHAR(100) NOT NULL DEFAULT '',
"float_nullable" FLOAT NULL DEFAULT NULL,
PRIMARY KEY (int_id));

CREATE TABLE

postgres=# INSERT INTO test (int_id, str, "float") VALUES (1,'test',2);
INSERT 0 1

postgresql> SELECT * FROM test;
int_id | int_nullable | float | str  | float_nullable
--------+--------------+-------+------+----------------
       1 |              |     2 | test |
(1 row)

Создание таблицы в ClickHouse и подключение к таблице PostgreSQL, созданной выше

В этом примере используется движок таблицы PostgreSQL, чтобы подключить таблицу ClickHouse к таблице PostgreSQL и выполнять в базе данных PostgreSQL операторы SELECT и INSERT:

CREATE TABLE default.postgresql_table
(
    `float_nullable` Nullable(Float32),
    `str` String,
    `int_id` Int32
)
ENGINE = PostgreSQL('localhost:5432', 'public', 'test', 'postgres_user', 'postgres_password');

Вставка исходных данных из таблицы PostgreSQL в таблицу ClickHouse с помощью запроса SELECT

Табличная функция postgresql копирует данные из PostgreSQL в ClickHouse. Это часто используют, чтобы повысить производительность запросов, выполняя запросы и аналитику в ClickHouse, а не в PostgreSQL; также её можно использовать для миграции данных из PostgreSQL в ClickHouse. Поскольку мы будем копировать данные из PostgreSQL в ClickHouse, используем в ClickHouse движок таблицы MergeTree и назовём её postgresql_copy:

CREATE TABLE default.postgresql_copy
(
    `float_nullable` Nullable(Float32),
    `str` String,
    `int_id` Int32
)
ENGINE = MergeTree
ORDER BY (int_id);

INSERT INTO default.postgresql_copy
SELECT * FROM postgresql('localhost:5432', 'public', 'test', 'postgres_user', 'postgres_password');

Вставка инкрементальных данных из таблицы PostgreSQL в таблицу ClickHouse

Если после первоначальной вставки нужно выполнять постоянную синхронизацию между таблицей PostgreSQL и таблицей ClickHouse, в ClickHouse можно использовать предложение WHERE, чтобы вставлять только те данные, которые были добавлены в PostgreSQL на основе временной метки или уникального ID. Для этого потребуется отслеживать максимальный ID или временную метку, добавленные ранее, например:

SELECT max(`int_id`) AS maxIntID FROM default.postgresql_copy;

Затем вставка значений из таблицы PostgreSQL, превышающих максимальное значение

INSERT INTO default.postgresql_copy
SELECT * FROM postgresql('localhost:5432', 'public', 'test', 'postgres_user', 'postgres_password')
WHERE int_id > (SELECT max(int_id) FROM default.postgresql_copy);

Выборка данных из итоговой таблицы ClickHouse

SELECT * FROM postgresql_copy WHERE str IN ('test');

┌─float_nullable─┬─str──┬─int_id─┐
│           ᴺᵁᴸᴸ │ test │      1 │
└────────────────┴──────┴────────┘

Использование нестандартной схемы

postgres=# CREATE SCHEMA "nice.schema";

postgres=# CREATE TABLE "nice.schema"."nice.table" (a integer);

postgres=# INSERT INTO "nice.schema"."nice.table" SELECT i FROM generate_series(0, 99) as t(i)

CREATE TABLE pg_table_schema_with_dots (a UInt32)
        ENGINE PostgreSQL('localhost:5432', 'clickhouse', 'nice.table', 'postgrsql_user', 'password', 'nice.schema');

См. также

​Создание таблицы

​Настройки

​postgresql_connection_pool_size

​postgresql_connection_pool_wait_timeout

​postgresql_connection_pool_retries

​postgresql_connection_pool_auto_close_connection

​postgresql_connection_attempt_timeout

​Подробности реализации

​Передача запроса вместо имени таблицы

​Пример использования

​Таблица в PostgreSQL

​Создание таблицы в ClickHouse и подключение к таблице PostgreSQL, созданной выше

​Вставка исходных данных из таблицы PostgreSQL в таблицу ClickHouse с помощью запроса SELECT

​Вставка инкрементальных данных из таблицы PostgreSQL в таблицу ClickHouse

​Выборка данных из итоговой таблицы ClickHouse

​Использование нестандартной схемы

​Связанные материалы

Создание таблицы

Настройки

`postgresql_connection_pool_size`

`postgresql_connection_pool_wait_timeout`

`postgresql_connection_pool_retries`

`postgresql_connection_pool_auto_close_connection`

`postgresql_connection_attempt_timeout`

Подробности реализации

Передача запроса вместо имени таблицы

Пример использования

Таблица в PostgreSQL

Создание таблицы в ClickHouse и подключение к таблице PostgreSQL, созданной выше

Вставка исходных данных из таблицы PostgreSQL в таблицу ClickHouse с помощью запроса SELECT

Вставка инкрементальных данных из таблицы PostgreSQL в таблицу ClickHouse

Выборка данных из итоговой таблицы ClickHouse

Использование нестандартной схемы

Связанные материалы