IT заметки по программированию
IT заметки по программированию
IT заметки по программированию
IT заметки по программированию

Golang migrate.New как указывать параметры для Clickhouse

14.04.2024
ClickHouse
Комментариев нет

Библиотека migrate (из пакета github.com/golang-migrate/migrate) поддерживает ClickHouse как источник данных для миграций. Чтобы использовать migrate.New или другие методы для миграции в ClickHouse, параметры подключения задаются через строку DSN.

Указание параметров для ClickHouse в migrate

При использовании migrate.New для работы с ClickHouse, строка подключения указывается в следующем формате:

Default
1
2
clickhouse://<username>:<password>@<host>:<port>/<database>?<query_parameters>
 

  • <username>: Имя пользователя (по умолчанию default).
  • <password>: Пароль (по умолчанию пустой).
  • <host>: Хост ClickHouse (например, 127.0.0.1).
  • <port>: Порт (обычно 9000).
  • <database>: Имя базы данных.
  • <query_parameters>: Дополнительные параметры подключения.

Пример использования migrate.New с ClickHouse

Go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package main
 
import (
"log"
 
"github.com/golang-migrate/migrate/v4"
_ "github.com/golang-migrate/migrate/v4/database/clickhouse" // для ClickHouse
_ "github.com/golang-migrate/migrate/v4/source/file"         // для чтения миграций из файлов
)
 
func main() {
// Строка подключения к ClickHouse
dsn := "clickhouse://default:@127.0.0.1:9000/default"
 
// Путь к файлам миграций
migrationsPath := "file://path/to/migrations"
 
// Создание экземпляра миграций
m, err := migrate.New(migrationsPath, dsn)
if err != nil {
log.Fatalf("Failed to create migration instance: %v", err)
}
 
// Применение всех миграций
if err := m.Up(); err != nil && err != migrate.ErrNoChange {
log.Fatalf("Failed to apply migrations: %v", err)
}
 
log.Println("Migrations applied successfully!")
}
 

Поддерживаемые параметры строки DSN

Для ClickHouse поддерживаются следующие параметры в строке DSN:

  • read_timeout: Тайм-аут чтения (например, 10s).
  • write_timeout: Тайм-аут записи.
  • secure: Включение TLS-соединения (true или false).
  • debug: Включение отладочного режима (true или false).
  • compress: Использовать сжатие (true или false).

Примеры строк DSN

  1. Подключение без пароля
    Shell
    1
    2
    clickhouse://default:@127.0.0.1:9000/default
     
     
  2. С параметрами отладки и сжатия
    Default
    1
    2
    clickhouse://default:@127.0.0.1:9000/default?debug=true&compress=true
     
     
  3. С тайм-аутами
    Default
    1
    2
    clickhouse://default:@127.0.0.1:9000/default?read_timeout=10s&write_timeout=10s
     
     
  4. С TLS
    Default
    1
    2
    clickhouse://default:@127.0.0.1:9440/default?secure=true
     
     

Организация миграций

  1. Формат миграционных файлов Миграции для ClickHouse обычно пишутся в формате SQL-файлов:
    Default
    1
    2
    3
    0001_create_table.up.sql
    0001_create_table.down.sql
     
     
  2. Пример содержимого миграции 0001_create_table.up.sql:
    PgSQL
    1
    2
    3
    4
    5
    6
    7
    CREATE TABLE example (
        id UInt64,
        name String,
        created_at DateTime
    ) ENGINE = MergeTree()
    ORDER BY id;
     
    0001_create_table.down.sql:
    PgSQL
    1
    2
    DROP TABLE example;
     
     

Установка библиотеки migrate

Убедитесь, что библиотека migrate и её зависимости для ClickHouse установлены:

Shell
1
2
3
4
go get -u github.com/golang-migrate/migrate/v4
go get -u github.com/golang-migrate/migrate/v4/database/clickhouse
go get -u github.com/golang-migrate/migrate/v4/source/file
 

 

Recommended Posts

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *