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

Предварительные требования и инструкции по настройке для разработки ClickHouse

ClickHouse можно собирать в Linux, FreeBSD и macOS. Если вы используете Windows, ClickHouse всё равно можно собрать в виртуальной машине под управлением Linux, например в VirtualBox с Ubuntu.

​

Создайте репозиторий на GitHub

Чтобы начать разрабатывать для ClickHouse, вам понадобится учетная запись GitHub. Также локально сгенерируйте SSH-ключ (если у вас его еще нет) и загрузите открытый ключ в GitHub, так как это обязательное условие для отправки исправлений.

Затем создайте форк репозитория ClickHouse в своей учетной записи, нажав кнопку “fork” в правом верхнем углу.

Чтобы внести изменения, например исправление ошибки или новую возможность, сначала закоммитьте свои изменения в ветку своего форка, а затем создайте “Pull Request” с этими изменениями в основной репозиторий.

Для работы с Git-репозиториями установите Git. Например, в Ubuntu выполните:

sudo apt update
sudo apt install git

Шпаргалка по Git доступна здесь. Подробное руководство по Git доступно здесь.

​

Клонируйте репозиторий на локальную машину

Сначала скачайте исходные файлы на локальную машину, то есть клонируйте репозиторий:

git clone [e-mail]:your_github_username/ClickHouse.git  # замените placeholder на ваше имя пользователя на GitHub
cd ClickHouse

Эта команда создаёт каталог ClickHouse/, содержащий исходный код, тесты и другие файлы. После URL можно указать собственный каталог для извлечения, но важно, чтобы этот путь не содержал пробелов, так как это может впоследствии нарушить сборку.

Git-репозиторий ClickHouse использует подмодули для подключения сторонних библиотек. По умолчанию подмодули не извлекаются. Вы можете либо

• запустить git clone с параметром --recurse-submodules,

• если git clone был запущен без --recurse-submodules, выполните git submodule update --init --jobs <N>, чтобы явно извлечь все подмодули. (<N> можно, например, задать равным 12, чтобы распараллелить загрузку.)

• если git clone был запущен без --recurse-submodules и вы хотите использовать shallow checkout подмодулей, чтобы не загружать их историю и сэкономить место, выполните ./contrib/update-submodules.sh. Этот вариант используется в CI, но не рекомендуется для локальной разработки, так как делает работу с подмодулями менее удобной и более медленной.

Чтобы проверить состояние Git-подмодулей, выполните git submodule status.

Если вы получаете следующее сообщение об ошибке

Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

SSH-ключи для подключения к GitHub отсутствуют. Обычно эти ключи находятся в ~/.ssh. Чтобы GitHub принимал SSH-ключи, их нужно загрузить в настройках GitHub.

Вы также можете клонировать репозиторий по HTTPS:

git clone https://github.com/ClickHouse/ClickHouse.git

Однако в этом случае вы не сможете отправлять свои изменения на сервер. Тем не менее этот вариант можно использовать временно, а SSH-ключи добавить позже, заменив удалённый адрес репозитория с помощью команды git remote.

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

git remote add upstream [e-mail]:ClickHouse/ClickHouse.git

После успешного выполнения этой команды вы сможете получать обновления из основного репозитория ClickHouse с помощью git pull upstream master.

Пожалуйста, не используйте просто git push: вы можете отправить изменения не в тот удалённый репозиторий и/или не в ту ветку. Лучше явно указывать имена удалённого репозитория и ветки, например: git push origin my_branch_name.

​

Написание кода

Ниже приведены несколько ссылок, которые могут быть полезны при написании кода для ClickHouse:

• Архитектура ClickHouse.
• Руководство по стилю кода.
• Сторонние библиотеки
• Написание тестов
• Открытые задачи

​

IDE

Visual Studio Code и Neovim — два варианта, которые хорошо подходят для разработки ClickHouse. Если вы используете VS Code, мы рекомендуем расширение clangd вместо IntelliSense, так как оно работает значительно быстрее.

CLion — ещё одна отличная альтернатива. Однако на крупных проектах, таких как ClickHouse, он может работать медленнее. Вот несколько моментов, о которых стоит помнить при использовании CLion:

• CLion самостоятельно создаёт путь build и автоматически выбирает debug в качестве типа сборки
• Он использует версию CMake, заданную в CLion, а не ту, которую вы установили
• CLion использует make для запуска задач сборки вместо ninja (это нормальное поведение)

Среди других IDE, которые можно использовать, — Sublime Text, Qt Creator и Kate.

​

Создайте pull request

Перейдите в репозиторий своего форка в интерфейсе GitHub. Если вы вели разработку в ветке, нужно выбрать именно эту ветку. На экране будет кнопка “Pull request”. По сути, это означает «создать запрос на принятие моих изменений в основной репозиторий».

Pull request можно создать, даже если работа еще не завершена. В этом случае добавьте слово “WIP” (work in progress) в начало заголовка — позже его можно будет изменить. Это полезно для совместной проверки и обсуждения изменений, а также для запуска всех доступных тестов. Важно добавить краткое описание ваших изменений — позже оно будет использовано при формировании changelog релиза.

Тестирование начнется, как только сотрудники ClickHouse пометят ваш PR меткой “can be tested”. Результаты некоторых первых проверок (например, стиля кода) появятся через несколько минут. Результаты проверки сборок поступят в течение получаса. Результаты основного набора тестов появятся в течение часа.

Система подготовит отдельные бинарные сборки ClickHouse для вашего pull request. Чтобы получить эти сборки, нажмите ссылку “Details” рядом с пунктом “Builds” в списке проверок. Там вы найдете прямые ссылки на собранные .deb-пакеты ClickHouse, которые можно развернуть даже на серверах в продакшне (если не боитесь).

​

Документируйте изменения

Каждый pull request, добавляющий новую возможность, должен сопровождаться соответствующей документацией. Если вы хотите предварительно просмотреть изменения в документации, следуйте инструкциям в README документации (mint dev из docs/). При добавлении новой функции в ClickHouse вы можете использовать приведённый ниже шаблон как образец:

# newFunctionName

A short description of the function goes here. It should describe briefly what it does and a typical usage case.

**Syntax**

\```sql
newFunctionName(arg1, arg2[, arg3])
\```

**Arguments**

- `arg1` — Description of the argument. [DataType](/reference/data-types/float)
- `arg2` — Description of the argument. [DataType](/reference/data-types/float)
- `arg3` — Description of optional argument (optional). [DataType](/reference/data-types/float)

**Implementation Details**

A description of implementation details if relevant.

**Returned value**

- Returns {insert what the function returns here}. [DataType](/reference/data-types/float)

**Example**

\```sql title="Query"
SELECT 'write your example query here';
\```

\```response title="Response"
┌───────────────────────────────────┐
│ the result of the query           │
└───────────────────────────────────┘
\```

​

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

При разработке ClickHouse часто возникает необходимость загружать реалистичные наборы данных. Это особенно важно при тестировании производительности. У нас есть специально подготовленный набор анонимизированных данных веб-аналитики. Для этого дополнительно потребуется около 3 ГБ свободного места на диске.

    sudo apt install wget xz-utils

    wget https://datasets.clickhouse.com/hits/tsv/hits_v1.tsv.xz
    wget https://datasets.clickhouse.com/visits/tsv/visits_v1.tsv.xz

    xz -v -d hits_v1.tsv.xz
    xz -v -d visits_v1.tsv.xz

    clickhouse-client

В clickhouse-client:

CREATE DATABASE IF NOT EXISTS test;

CREATE TABLE test.hits ( WatchID UInt64,  JavaEnable UInt8,  Title String,  GoodEvent Int16,  EventTime DateTime,  EventDate Date,  CounterID UInt32,  ClientIP UInt32,  ClientIP6 FixedString(16),  RegionID UInt32,  UserID UInt64,  CounterClass Int8,  OS UInt8,  UserAgent UInt8,  URL String,  Referer String,  URLDomain String,  RefererDomain String,  Refresh UInt8,  IsRobot UInt8,  RefererCategories Array(UInt16),  URLCategories Array(UInt16),  URLRegions Array(UInt32),  RefererRegions Array(UInt32),  ResolutionWidth UInt16,  ResolutionHeight UInt16,  ResolutionDepth UInt8,  FlashMajor UInt8,  FlashMinor UInt8,  FlashMinor2 String,  NetMajor UInt8,  NetMinor UInt8,  UserAgentMajor UInt16,  UserAgentMinor FixedString(2),  CookieEnable UInt8,  JavascriptEnable UInt8,  IsMobile UInt8,  MobilePhone UInt8,  MobilePhoneModel String,  Params String,  IPNetworkID UInt32,  TraficSourceID Int8,  SearchEngineID UInt16,  SearchPhrase String,  AdvEngineID UInt8,  IsArtifical UInt8,  WindowClientWidth UInt16,  WindowClientHeight UInt16,  ClientTimeZone Int16,  ClientEventTime DateTime,  SilverlightVersion1 UInt8,  SilverlightVersion2 UInt8,  SilverlightVersion3 UInt32,  SilverlightVersion4 UInt16,  PageCharset String,  CodeVersion UInt32,  IsLink UInt8,  IsDownload UInt8,  IsNotBounce UInt8,  FUniqID UInt64,  HID UInt32,  IsOldCounter UInt8,  IsEvent UInt8,  IsParameter UInt8,  DontCountHits UInt8,  WithHash UInt8,  HitColor FixedString(1),  UTCEventTime DateTime,  Age UInt8,  Sex UInt8,  Income UInt8,  Interests UInt16,  Robotness UInt8,  GeneralInterests Array(UInt16),  RemoteIP UInt32,  RemoteIP6 FixedString(16),  WindowName Int32,  OpenerName Int32,  HistoryLength Int16,  BrowserLanguage FixedString(2),  BrowserCountry FixedString(2),  SocialNetwork String,  SocialAction String,  HTTPError UInt16,  SendTiming Int32,  DNSTiming Int32,  ConnectTiming Int32,  ResponseStartTiming Int32,  ResponseEndTiming Int32,  FetchTiming Int32,  RedirectTiming Int32,  DOMInteractiveTiming Int32,  DOMContentLoadedTiming Int32,  DOMCompleteTiming Int32,  LoadEventStartTiming Int32,  LoadEventEndTiming Int32,  NSToDOMContentLoadedTiming Int32,  FirstPaintTiming Int32,  RedirectCount Int8,  SocialSourceNetworkID UInt8,  SocialSourcePage String,  ParamPrice Int64,  ParamOrderID String,  ParamCurrency FixedString(3),  ParamCurrencyID UInt16,  GoalsReached Array(UInt32),  OpenstatServiceName String,  OpenstatCampaignID String,  OpenstatAdID String,  OpenstatSourceID String,  UTMSource String,  UTMMedium String,  UTMCampaign String,  UTMContent String,  UTMTerm String,  FromTag String,  HasGCLID UInt8,  RefererHash UInt64,  URLHash UInt64,  CLID UInt32,  YCLID UInt64,  ShareService String,  ShareURL String,  ShareTitle String,  `ParsedParams.Key1` Array(String),  `ParsedParams.Key2` Array(String),  `ParsedParams.Key3` Array(String),  `ParsedParams.Key4` Array(String),  `ParsedParams.Key5` Array(String),  `ParsedParams.ValueDouble` Array(Float64),  IslandID FixedString(16),  RequestNum UInt32,  RequestTry UInt8) ENGINE = MergeTree PARTITION BY toYYYYMM(EventDate) SAMPLE BY intHash32(UserID) ORDER BY (CounterID, EventDate, intHash32(UserID), EventTime);

CREATE TABLE test.visits ( CounterID UInt32,  StartDate Date,  Sign Int8,  IsNew UInt8,  VisitID UInt64,  UserID UInt64,  StartTime DateTime,  Duration UInt32,  UTCStartTime DateTime,  PageViews Int32,  Hits Int32,  IsBounce UInt8,  Referer String,  StartURL String,  RefererDomain String,  StartURLDomain String,  EndURL String,  LinkURL String,  IsDownload UInt8,  TraficSourceID Int8,  SearchEngineID UInt16,  SearchPhrase String,  AdvEngineID UInt8,  PlaceID Int32,  RefererCategories Array(UInt16),  URLCategories Array(UInt16),  URLRegions Array(UInt32),  RefererRegions Array(UInt32),  IsYandex UInt8,  GoalReachesDepth Int32,  GoalReachesURL Int32,  GoalReachesAny Int32,  SocialSourceNetworkID UInt8,  SocialSourcePage String,  MobilePhoneModel String,  ClientEventTime DateTime,  RegionID UInt32,  ClientIP UInt32,  ClientIP6 FixedString(16),  RemoteIP UInt32,  RemoteIP6 FixedString(16),  IPNetworkID UInt32,  SilverlightVersion3 UInt32,  CodeVersion UInt32,  ResolutionWidth UInt16,  ResolutionHeight UInt16,  UserAgentMajor UInt16,  UserAgentMinor UInt16,  WindowClientWidth UInt16,  WindowClientHeight UInt16,  SilverlightVersion2 UInt8,  SilverlightVersion4 UInt16,  FlashVersion3 UInt16,  FlashVersion4 UInt16,  ClientTimeZone Int16,  OS UInt8,  UserAgent UInt8,  ResolutionDepth UInt8,  FlashMajor UInt8,  FlashMinor UInt8,  NetMajor UInt8,  NetMinor UInt8,  MobilePhone UInt8,  SilverlightVersion1 UInt8,  Age UInt8,  Sex UInt8,  Income UInt8,  JavaEnable UInt8,  CookieEnable UInt8,  JavascriptEnable UInt8,  IsMobile UInt8,  BrowserLanguage UInt16,  BrowserCountry UInt16,  Interests UInt16,  Robotness UInt8,  GeneralInterests Array(UInt16),  Params Array(String),  `Goals.ID` Array(UInt32),  `Goals.Serial` Array(UInt32),  `Goals.EventTime` Array(DateTime),  `Goals.Price` Array(Int64),  `Goals.OrderID` Array(String),  `Goals.CurrencyID` Array(UInt32),  WatchIDs Array(UInt64),  ParamSumPrice Int64,  ParamCurrency FixedString(3),  ParamCurrencyID UInt16,  ClickLogID UInt64,  ClickEventID Int32,  ClickGoodEvent Int32,  ClickEventTime DateTime,  ClickPriorityID Int32,  ClickPhraseID Int32,  ClickPageID Int32,  ClickPlaceID Int32,  ClickTypeID Int32,  ClickResourceID Int32,  ClickCost UInt32,  ClickClientIP UInt32,  ClickDomainID UInt32,  ClickURL String,  ClickAttempt UInt8,  ClickOrderID UInt32,  ClickBannerID UInt32,  ClickMarketCategoryID UInt32,  ClickMarketPP UInt32,  ClickMarketCategoryName String,  ClickMarketPPName String,  ClickAWAPSCampaignName String,  ClickPageName String,  ClickTargetType UInt16,  ClickTargetPhraseID UInt64,  ClickContextType UInt8,  ClickSelectType Int8,  ClickOptions String,  ClickGroupBannerID Int32,  OpenstatServiceName String,  OpenstatCampaignID String,  OpenstatAdID String,  OpenstatSourceID String,  UTMSource String,  UTMMedium String,  UTMCampaign String,  UTMContent String,  UTMTerm String,  FromTag String,  HasGCLID UInt8,  FirstVisit DateTime,  PredLastVisit Date,  LastVisit Date,  TotalVisits UInt32,  `TraficSource.ID` Array(Int8),  `TraficSource.SearchEngineID` Array(UInt16),  `TraficSource.AdvEngineID` Array(UInt8),  `TraficSource.PlaceID` Array(UInt16),  `TraficSource.SocialSourceNetworkID` Array(UInt8),  `TraficSource.Domain` Array(String),  `TraficSource.SearchPhrase` Array(String),  `TraficSource.SocialSourcePage` Array(String),  Attendance FixedString(16),  CLID UInt32,  YCLID UInt64,  NormalizedRefererHash UInt64,  SearchPhraseHash UInt64,  RefererDomainHash UInt64,  NormalizedStartURLHash UInt64,  StartURLDomainHash UInt64,  NormalizedEndURLHash UInt64,  TopLevelDomain UInt64,  URLScheme UInt64,  OpenstatServiceNameHash UInt64,  OpenstatCampaignIDHash UInt64,  OpenstatAdIDHash UInt64,  OpenstatSourceIDHash UInt64,  UTMSourceHash UInt64,  UTMMediumHash UInt64,  UTMCampaignHash UInt64,  UTMContentHash UInt64,  UTMTermHash UInt64,  FromHash UInt64,  WebVisorEnabled UInt8,  WebVisorActivity UInt32,  `ParsedParams.Key1` Array(String),  `ParsedParams.Key2` Array(String),  `ParsedParams.Key3` Array(String),  `ParsedParams.Key4` Array(String),  `ParsedParams.Key5` Array(String),  `ParsedParams.ValueDouble` Array(Float64),  `Market.Type` Array(UInt8),  `Market.GoalID` Array(UInt32),  `Market.OrderID` Array(String),  `Market.OrderPrice` Array(Int64),  `Market.PP` Array(UInt32),  `Market.DirectPlaceID` Array(UInt32),  `Market.DirectOrderID` Array(UInt32),  `Market.DirectBannerID` Array(UInt32),  `Market.GoodID` Array(String),  `Market.GoodName` Array(String),  `Market.GoodQuantity` Array(Int32),  `Market.GoodPrice` Array(Int64),  IslandID FixedString(16)) ENGINE = CollapsingMergeTree(Sign) PARTITION BY toYYYYMM(StartDate) SAMPLE BY intHash32(UserID) ORDER BY (CounterID, StartDate, intHash32(UserID), VisitID);

Импортируйте данные:

clickhouse-client --max_insert_block_size 100000 --query "INSERT INTO test.hits FORMAT TSV" < hits_v1.tsv
clickhouse-client --max_insert_block_size 100000 --query "INSERT INTO test.visits FORMAT TSV" < visits_v1.tsv