mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-30 13:40:50 +00:00
Added quick start instruction
This commit is contained in:
Alexey Milovidov
parent
18e512d069
commit
0852bc98bf
157
dbms/tests/instructions/developer_instruction_ru.md
Normal file
157
dbms/tests/instructions/developer_instruction_ru.md
Normal file
@ -0,0 +1,157 @@
|
||||
Сборка ClickHouse поддерживается на Linux, FreeBSD, Mac OS X.
|
||||
|
||||
|
||||
# Если вы используете Windows
|
||||
|
||||
Если вы используете Windows, вам потребуется создать виртуальную машину с Ubuntu. Для работы с виртуальной машиной, установите VirtualBox. Скачать Ubuntu можно на сайте: https://www.ubuntu.com/#download Создайте виртуальную машину из полученного образа. Выделите для неё не менее 4 GB оперативной памяти. Для запуска терминала в Ubuntu, найдите в меню программу со словом terminal (gnome-terminal, konsole или что-то в этом роде) или нажмите Ctrl+Alt+T.
|
||||
|
||||
|
||||
# Создание репозитория на GitHub
|
||||
|
||||
Для работы с репозиторием ClickHouse, вам потребуется аккаунт на GitHub. Наверное, он у вас уже есть.
|
||||
|
||||
Если аккаунта нет - зарегистрируйтесь на https://github.com/. Создайте ssh ключи, если их нет, и загрузите публичные ключи на GitHub. Это потребуется для отправки изменений. Для работы с GitHub можно использовать такие же ssh ключи, что и для работы с другими ssh серверами - скорее всего, они уже у вас есть.
|
||||
|
||||
Создайте fork репозитория ClickHouse. Для этого, на странице https://github.com/yandex/ClickHouse нажмите на кнопку "fork" в правом верхнем углу. Вы получите полную копию репозитория ClickHouse на своём аккаунте, которая называется "форк". Процесс разработки состоит в том, чтобы внести нужные изменения в свой форк репозитория, а затем создать "pull request" для принятия изменений в основной репозиторий.
|
||||
|
||||
Для работы с git репозиториями, установите `git`.
|
||||
|
||||
В Ubuntu выполните в терминале:
|
||||
```
|
||||
sudo apt update
|
||||
sudo apt install git
|
||||
```
|
||||
|
||||
|
||||
# Клонирование репозитория на рабочую машину
|
||||
|
||||
Затем вам потребуется загрузить исходники для работы на свой компьютер. Это называется "клонирование репозитория", потому что создаёт на вашем компьютере локальную копию репозитория, с которой вы будете работать.
|
||||
|
||||
Выполните в терминале:
|
||||
```
|
||||
git clone --recursive git@github.com:yandex/ClickHouse.git
|
||||
cd ClickHouse
|
||||
```
|
||||
Замените *yandex* на имя вашего аккаунта на GitHub.
|
||||
|
||||
Эта команда создаст директорию ClickHouse, содержащую рабочую копию проекта.
|
||||
Необходимо, чтобы путь к рабочей копии не содержал пробелы в именах директорий. Это может привести к проблемам в работе системы сборки.
|
||||
|
||||
Обратите внимание, что репозиторий ClickHouse использует submodules. Так называются ссылки на дополнительные репозитории (например, внешние библиотеки, от которых зависит проект). Это значит, что при клонировании репозитория, следует указывать ключ `--recursive`, как в примере выше. Если репозиторий был клонирован без submodules, то для их скачивания, необходимо выполнить:
|
||||
```
|
||||
git submodule init
|
||||
git submodule update
|
||||
```
|
||||
Проверить наличие submodules можно с помощью команды `git submodule status`.
|
||||
|
||||
|
||||
# Система сборки
|
||||
|
||||
ClickHouse использует систему сборки CMake и Ninja.
|
||||
|
||||
CMake - генератор задач сборки.
|
||||
Ninja - система запуска сборочных задач.
|
||||
|
||||
Для установки на Ubuntu, или Debian, Mint, выполните `sudo apt install cmake ninja-build`.
|
||||
Для установки на CentOS, RedHat, выполните `sudo yum install cmake ninja-build`.
|
||||
Если у вас Arch или Gentoo, то вы сами знаете, как установить CMake.
|
||||
|
||||
Для установки CMake и Ninja на Mac OS X, сначала установите Homebrew, а затем, с помощью него, установите всё остальное.
|
||||
```
|
||||
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
|
||||
brew install cmake ninja
|
||||
```
|
||||
|
||||
|
||||
# Необязательные внешние библиотеки
|
||||
|
||||
ClickHouse использует для сборки некоторое количество внешних библиотек. Большинство из них не требуется отдельно устанавливать, так как они собираются вместе с ClickHouse, из исходников, которые расположены в submodules. Посмотреть набор этих библиотек можно в директории contrib.
|
||||
|
||||
Пара библиотек не собирается из исходников, а используется из системы: ICU и Readline, и их рекомендуется установить.
|
||||
Ubuntu: `sudo apt install libicu-dev libreadline-dev`
|
||||
Mac OS X: `brew install icu4c readline`
|
||||
Впрочем, эти библиотеки не обязательны для работы и ClickHouse может быть собран без них. ICU используется для поддержки `COLLATE` в `ORDER BY` (например, для сортировки с учётом турецкого алфавита). Readline используется для более удобного набора команд в интерактивном режиме в clickhouse-client.
|
||||
|
||||
|
||||
# Компилятор C++
|
||||
|
||||
В качестве компилятора C++ поддерживается GCC начиная с версии 7 или Clang начиная с версии 7.
|
||||
Официальные сборки от Яндекса, на данный момент, используют GCC, так как он генерирует слегка более производительный машинный код (разница в среднем до нескольких процентов по нашим бенчмаркам). Clang обычно более удобен для разработки. Впрочем, наша среда continuous integration проверяет около десятка вариантов сборки.
|
||||
|
||||
Для установки GCC под Ubuntu, выполните: `sudo apt install gcc g++`.
|
||||
Проверьте версию gcc: `gcc --version`. Если версия меньше 7, то следуйте инструкции: https://clickhouse.yandex/docs/en/development/build/#install-gcc-7
|
||||
|
||||
Для установки GCC под Mac OS X, выполните `brew install gcc`.
|
||||
|
||||
Если вы решили использовать Clang, вы также можете установить `libc++` и `lld`, если вы знаете, что это такое. При желании, установите ccache.
|
||||
|
||||
|
||||
# Процесс сборки
|
||||
|
||||
Теперь вы готовы к сборке ClickHouse. Для размещения собранных файлов, рекомендуется создать отдельную директорию build внутри директории ClickHouse:
|
||||
```
|
||||
mkdir build
|
||||
cd build
|
||||
```
|
||||
Вы можете иметь несколько разных директорий (build_release, build_debug) для разных вариантов сборки.
|
||||
|
||||
Находясь в директории build, выполните конфигурацию сборки с помощью CMake:
|
||||
```
|
||||
cmake ..
|
||||
```
|
||||
|
||||
Для более быстрой сборки, можно использовать debug вариант - сборку без оптимизаций. Для этого, укажите параметр `-D CMAKE_BUILD_TYPE=Debug`:
|
||||
```
|
||||
cmake -D CMAKE_BUILD_TYPE=Debug ..
|
||||
```
|
||||
Вы можете изменить вариант сборки, выполнив эту команду в директории build.
|
||||
|
||||
|
||||
Запустите ninja для сборки:
|
||||
```
|
||||
ninja
|
||||
```
|
||||
|
||||
Можно ограничить сборку только нужными программами:
|
||||
```
|
||||
ninja clickhouse-server clickhouse-client
|
||||
```
|
||||
|
||||
Для полной сборки требуется около 30 GB свободного места на диске или 15 GB для сборки только основных программ.
|
||||
|
||||
При наличии небольшого количества оперативной памяти на компьютере, следует ограничить количество параллельных задач с помощью параметра `-j`:
|
||||
```
|
||||
ninja -j 1 clickhouse-server clickhouse-client
|
||||
```
|
||||
На машинах с 4 GB памяти, рекомендуется указывать значение 1, а если памяти до 8 GB, укажите значение 2.
|
||||
|
||||
Если вы получили сообщение `ninja: error: loading 'build.ninja': No such file or directory`, значит конфигурация сборки прошла с ошибкой и вам необходимо посмотреть на сообщение об ошибке выше.
|
||||
|
||||
Иначе вы увидите прогресс сборки - количество обработанных задач и общее количество задач.
|
||||
|
||||
В процессе сборки могут появится сообщения `libprotobuf WARNING` про protobuf файлы в библиотеке libhdfs2. Это не имеет значения.
|
||||
|
||||
При успешной сборке, вы получите готовый исполняемый файл `ClickHouse/build/dbms/programs/clickhouse`:
|
||||
`ls -l dbms/programs/clickhouse`
|
||||
|
||||
|
||||
# Запуск собранной версии ClickHouse
|
||||
|
||||
Для запуска сервера из под текущего пользователя, с выводом логов в терминал и с использованием примеров конфигурационных файлов, расположенных в исходниках, перейдите в директорию `ClickHouse/dbms/programs/server/` (эта директория находится не в директории build) и выполните:
|
||||
|
||||
```
|
||||
../../../build/dbms/programs/clickhouse server
|
||||
```
|
||||
|
||||
В этом случае, ClickHouse будет использовать конфигурационные файлы, расположенные в текущей директории. Вы можете запустить `clickhouse server` из любой директории, передав ему путь к конфигурационному файлу в аргументе командной строки `--config-file`.
|
||||
|
||||
Для подключения к ClickHouse с помощью clickhouse-client, в соседнем терминале, зайдите в директорию `ClickHouse/build/dbms/programs/` и выполните `clickhouse client`.
|
||||
|
||||
|
||||
# Среда разработки
|
||||
|
||||
Если вы не знаете, какую среду разработки использовать, то рекомендуется использовать CLion. CLion является платным ПО, но его можно использовать бесплатно в течение пробного периода. Также он бесплатен для учащихся. CLion можно использовать как под Linux, так и под Mac OS X.
|
||||
|
||||
Также в качестве среды разработки, вы можете использовать KDevelop или QTCreator. KDevelop - очень удобная, но нестабильная среда разработки. Если KDevelop вылетает через небольшое время после открытия проекта, вам следует нажать на кнопку "Stop All" как только он открыл список файлов проекта. После этого, KDevelop можно будет использовать.
|
||||
|
||||
В качестве простых редакторов кода можно использовать Sublime Text или Visual Studio Code или Kate (все варианты доступны под Linux).
|
||||
Loading…
Reference in New Issue
Block a user