mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-20 06:32:08 +00:00
8623cb232c
* CLICKHOUSE-4063: less manual html @ index.md * CLICKHOUSE-4063: recommend markdown="1" in README.md * CLICKHOUSE-4003: manually purge custom.css for now * CLICKHOUSE-4064: expand <details> before any print (including to pdf) * CLICKHOUSE-3927: rearrange interfaces/formats.md a bit * CLICKHOUSE-3306: add few http headers * Remove copy-paste introduced in #3392 * Hopefully better chinese fonts #3392 * get rid of tabs @ custom.css * Apply comments and patch from #3384 * Add jdbc.md to ToC and some translation, though it still looks badly incomplete * minor punctuation * Add some backlinks to official website from mirrors that just blindly take markdown sources * Do not make fonts extra light * find . -name '*.md' -type f | xargs -I{} perl -pi -e 's//g' {} * find . -name '*.md' -type f | xargs -I{} perl -pi -e 's/ sql/g' {} * Remove outdated stuff from roadmap.md * Not so light font on front page too * Refactor Chinese formats.md to match recent changes in other languages
142 lines
3.9 KiB
Markdown
142 lines
3.9 KiB
Markdown
# Getting Started
|
|
|
|
## System Requirements
|
|
|
|
Installation from the official repository requires Linux with x86_64 architecture and support for the SSE 4.2 instruction set.
|
|
|
|
To check for SSE 4.2:
|
|
|
|
```bash
|
|
grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not supported"
|
|
```
|
|
|
|
We recommend using Ubuntu or Debian. The terminal must use UTF-8 encoding.
|
|
|
|
For rpm-based systems, you can use 3rd-party packages: https://packagecloud.io/altinity/clickhouse or install debian packages.
|
|
|
|
ClickHouse also works on FreeBSD and Mac OS X. It can be compiled for x86_64 processors without SSE 4.2 support, and for AArch64 CPUs.
|
|
|
|
## Installation
|
|
|
|
For testing and development, the system can be installed on a single server or on a desktop computer.
|
|
|
|
### Installing from Packages for Debian/Ubuntu
|
|
|
|
In `/etc/apt/sources.list` (or in a separate `/etc/apt/sources.list.d/clickhouse.list` file), add the repository:
|
|
|
|
```
|
|
deb http://repo.yandex.ru/clickhouse/deb/stable/ main/
|
|
```
|
|
|
|
If you want to use the most recent test version, replace 'stable' with 'testing'.
|
|
|
|
Then run:
|
|
|
|
```bash
|
|
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv E0C56BD4 # optional
|
|
sudo apt-get update
|
|
sudo apt-get install clickhouse-client clickhouse-server
|
|
```
|
|
|
|
You can also download and install packages manually from here: <https://repo.yandex.ru/clickhouse/deb/stable/main/>.
|
|
|
|
ClickHouse contains access restriction settings. They are located in the 'users.xml' file (next to 'config.xml').
|
|
By default, access is allowed from anywhere for the 'default' user, without a password. See 'user/default/networks'.
|
|
For more information, see the section "Configuration files".
|
|
|
|
### Installing from Sources
|
|
|
|
To compile, follow the instructions: build.md
|
|
|
|
You can compile packages and install them.
|
|
You can also use programs without installing packages.
|
|
|
|
```
|
|
Client: dbms/programs/clickhouse-client
|
|
Server: dbms/programs/clickhouse-server
|
|
```
|
|
|
|
For the server, create a catalog with data, such as:
|
|
|
|
```
|
|
/opt/clickhouse/data/default/
|
|
/opt/clickhouse/metadata/default/
|
|
```
|
|
|
|
(Configurable in the server config.)
|
|
Run 'chown' for the desired user.
|
|
|
|
Note the path to logs in the server config (src/dbms/programs/server/config.xml).
|
|
|
|
### Other Installation Methods
|
|
|
|
Docker image: <https://hub.docker.com/r/yandex/clickhouse-server/>
|
|
|
|
RPM packages for CentOS or RHEL: <https://github.com/Altinity/clickhouse-rpm-install>
|
|
|
|
Gentoo: `emerge clickhouse`
|
|
|
|
## Launch
|
|
|
|
To start the server (as a daemon), run:
|
|
|
|
```bash
|
|
sudo service clickhouse-server start
|
|
```
|
|
|
|
See the logs in the `/var/log/clickhouse-server/ directory.`
|
|
|
|
If the server doesn't start, check the configurations in the file `/etc/clickhouse-server/config.xml.`
|
|
|
|
You can also launch the server from the console:
|
|
|
|
```bash
|
|
clickhouse-server --config-file=/etc/clickhouse-server/config.xml
|
|
```
|
|
|
|
In this case, the log will be printed to the console, which is convenient during development.
|
|
If the configuration file is in the current directory, you don't need to specify the '--config-file' parameter. By default, it uses './config.xml'.
|
|
|
|
You can use the command-line client to connect to the server:
|
|
|
|
```bash
|
|
clickhouse-client
|
|
```
|
|
|
|
The default parameters indicate connecting with localhost:9000 on behalf of the user 'default' without a password.
|
|
The client can be used for connecting to a remote server. Example:
|
|
|
|
```bash
|
|
clickhouse-client --host=example.com
|
|
```
|
|
|
|
For more information, see the section "Command-line client".
|
|
|
|
Checking the system:
|
|
|
|
```bash
|
|
milovidov@hostname:~/work/metrica/src/dbms/src/Client$ ./clickhouse-client
|
|
ClickHouse client version 0.0.18749.
|
|
Connecting to localhost:9000.
|
|
Connected to ClickHouse server version 0.0.18749.
|
|
|
|
:) SELECT 1
|
|
|
|
SELECT 1
|
|
|
|
┌─1─┐
|
|
│ 1 │
|
|
└───┘
|
|
|
|
1 rows in set. Elapsed: 0.003 sec.
|
|
|
|
:)
|
|
```
|
|
|
|
**Congratulations, the system works!**
|
|
|
|
To continue experimenting, you can try to download from the test data sets.
|
|
|
|
|
|
[Original article](https://clickhouse.yandex/docs/en/getting_started/) <!--hide-->
|