REST-каталог

Beta feature. Learn more.

Примечание

Интеграция с REST Catalog работает только с таблицами Iceberg. Эта интеграция поддерживает как AWS S3, так и других провайдеров облачного хранилища.

ClickHouse поддерживает интеграцию с несколькими каталогами (Unity, Glue, REST, Polaris и т. д.). В этом руководстве пошагово описывается, как выполнять запросы к вашим данным с помощью ClickHouse и спецификации REST Catalog.

REST Catalog — это стандартизированная спецификация API для каталогов Iceberg, поддерживаемая различными платформами, включая:

• Локальные среды разработки (с конфигурациями docker-compose)
• Управляемые сервисы, такие как Tabular.io
• Самостоятельно развёрнутые реализации REST Catalog

Примечание

Поскольку эта функция находится в статусе бета-версии, вам необходимо включить её с помощью: SET allow_database_iceberg = 1;

Локальная среда разработки

Для локальной разработки и тестирования вы можете использовать контейнеризованный REST-каталог. Такой подход оптимален для обучения, прототипирования и окружений разработки.

Предварительные требования

1. Docker и Docker Compose: Убедитесь, что Docker установлен и запущен.
2. Пример окружения: Вы можете использовать различные конфигурации docker-compose (см. раздел об альтернативных образах Docker ниже).

Настройка локального REST-каталога

Вы можете использовать различные контейнеризованные реализации REST-каталога, такие как Databricks docker-spark-iceberg, которая предоставляет полноценную среду Spark + Iceberg + REST-каталог с помощью docker-compose, что делает её идеальной для тестирования интеграций с Iceberg.

Шаг 1. Создайте новую папку для запуска примера, затем создайте файл docker-compose.yml с конфигурацией из Databricks docker-spark-iceberg.

Шаг 2. Затем создайте файл docker-compose.override.yml и поместите в него следующую конфигурацию контейнера ClickHouse:

version: '3.8'

services:
  clickhouse:
    image: clickhouse/clickhouse-server:25.5.6
    container_name: clickhouse
    user: '0:0'  # Ensures root permissions
    ports:
      - "8123:8123"
      - "9002:9000"
    volumes:
      - ./clickhouse:/var/lib/clickhouse
      - ./clickhouse/data_import:/var/lib/clickhouse/data_import  # Mount dataset folder
    networks:
      - iceberg_net
    environment:
      - CLICKHOUSE_DB=default
      - CLICKHOUSE_USER=default
      - CLICKHOUSE_DO_NOT_CHOWN=1
      - CLICKHOUSE_PASSWORD=

Шаг 3: Выполните следующую команду, чтобы запустить сервисы:

docker compose up

Шаг 4: Дождитесь, пока все сервисы не будут готовы. Можно проверить логи:

docker-compose logs -f

Примечание

Для настройки REST-каталога необходимо, чтобы в таблицы Iceberg предварительно были загружены примерные данные. Перед тем как пытаться выполнять по ним запросы из ClickHouse, убедитесь, что среда Spark создала и заполнила таблицы. Доступность таблиц зависит от конкретной конфигурации docker-compose и скриптов загрузки примерных данных.

Подключение к локальному REST-каталогу

Подключитесь к своему контейнеру ClickHouse:

docker exec -it clickhouse clickhouse-client

Затем создайте подключение к базе данных REST-каталога:

SET allow_database_iceberg = 1;

CREATE DATABASE demo
ENGINE = DataLakeCatalog('http://rest:8181/v1', 'admin', 'password')
SETTINGS 
    catalog_type = 'rest', 
    storage_endpoint = 'http://minio:9000/lakehouse', 
    warehouse = 'demo'

Выполнение запросов к таблицам REST-каталога в ClickHouse

Теперь, когда соединение установлено, вы можете начинать выполнять запросы через REST-каталог. Например:

USE demo;

SHOW TABLES;

Если ваша конфигурация включает демонстрационные данные (например, датасет такси), вы должны увидеть следующие таблицы:

┌─name──────────┐
│ default.taxis │
└───────────────┘

Примечание

Если вы не видите никаких таблиц, это обычно означает, что:

1. Среда Spark ещё не создала таблицы-примеры
2. Служба REST-каталога ещё не полностью инициализирована
3. Процесс загрузки демонстрационных данных ещё не завершён

Вы можете проверить логи Spark, чтобы отслеживать ход создания таблиц:

docker-compose logs spark

Чтобы выполнить запрос к таблице (если она доступна):

SELECT count(*) FROM `default.taxis`;

┌─count()─┐
│ 2171187 │
└─────────┘

Требуются обратные кавычки

Обратные кавычки требуются, потому что ClickHouse поддерживает только одно пространство имен.

Чтобы просмотреть DDL таблицы:

SHOW CREATE TABLE `default.taxis`;

┌─statement─────────────────────────────────────────────────────────────────────────────────────┐
│ CREATE TABLE demo.`default.taxis`                                                             │
│ (                                                                                             │
│     `VendorID` Nullable(Int64),                                                               │
│     `tpep_pickup_datetime` Nullable(DateTime64(6)),                                           │
│     `tpep_dropoff_datetime` Nullable(DateTime64(6)),                                          │
│     `passenger_count` Nullable(Float64),                                                      │
│     `trip_distance` Nullable(Float64),                                                        │
│     `RatecodeID` Nullable(Float64),                                                           │
│     `store_and_fwd_flag` Nullable(String),                                                    │
│     `PULocationID` Nullable(Int64),                                                           │
│     `DOLocationID` Nullable(Int64),                                                           │
│     `payment_type` Nullable(Int64),                                                           │
│     `fare_amount` Nullable(Float64),                                                          │
│     `extra` Nullable(Float64),                                                                │
│     `mta_tax` Nullable(Float64),                                                              │
│     `tip_amount` Nullable(Float64),                                                           │
│     `tolls_amount` Nullable(Float64),                                                         │
│     `improvement_surcharge` Nullable(Float64),                                                │
│     `total_amount` Nullable(Float64),                                                         │
│     `congestion_surcharge` Nullable(Float64),                                                 │
│     `airport_fee` Nullable(Float64)                                                           │
│ )                                                                                             │
│ ENGINE = Iceberg('http://minio:9000/lakehouse/warehouse/default/taxis/', 'admin', '[HIDDEN]') │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Загрузка данных из вашего озера данных в ClickHouse

Если вам нужно загрузить данные из REST-каталога в ClickHouse, начните с создания локальной таблицы ClickHouse:

CREATE TABLE taxis
(
    `VendorID` Int64,
    `tpep_pickup_datetime` DateTime64(6),
    `tpep_dropoff_datetime` DateTime64(6),
    `passenger_count` Float64,
    `trip_distance` Float64,
    `RatecodeID` Float64,
    `store_and_fwd_flag` String,
    `PULocationID` Int64,
    `DOLocationID` Int64,
    `payment_type` Int64,
    `fare_amount` Float64,
    `extra` Float64,
    `mta_tax` Float64,
    `tip_amount` Float64,
    `tolls_amount` Float64,
    `improvement_surcharge` Float64,
    `total_amount` Float64,
    `congestion_surcharge` Float64,
    `airport_fee` Float64
)
ENGINE = MergeTree()
PARTITION BY toYYYYMM(tpep_pickup_datetime)
ORDER BY (VendorID, tpep_pickup_datetime, PULocationID, DOLocationID);

Затем загрузите данные из таблицы каталога REST с помощью оператора INSERT INTO SELECT:

INSERT INTO taxis 
SELECT * FROM demo.`default.taxis`;