thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-27 10:02:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #63267 from rschu1ze/docs-install

Browse Source 
Docs: Update install instructions
This commit is contained in:
Robert Schulze 2024-05-02 14:00:31 +00:00 committed by GitHub
commit 3bb9f962be
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/en/getting-started/install.md
View File

@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock';
# Install ClickHouse # Install ClickHouse
You have three options for getting up and running with ClickHouse: You have four options for getting up and running with ClickHouse:
- **[ClickHouse Cloud](https://clickhouse.com/cloud/):** The official ClickHouse as a service, - built by, maintained and supported by the creators of ClickHouse - **[ClickHouse Cloud](https://clickhouse.com/cloud/):** The official ClickHouse as a service, - built by, maintained and supported by the creators of ClickHouse
- **[Quick Install](#quick-install):** an easy-to-download binary for testing and developing with ClickHouse - **[Quick Install](#quick-install):** an easy-to-download binary for testing and developing with ClickHouse
@ -32,21 +32,29 @@ On Linux, macOS and FreeBSD:
1. If you are just getting started and want to see what ClickHouse can do, the simplest way to download ClickHouse locally is to run the 1. If you are just getting started and want to see what ClickHouse can do, the simplest way to download ClickHouse locally is to run the
following command. It downloads a single binary for your operating system that can be used to run the ClickHouse server, following command. It downloads a single binary for your operating system that can be used to run the ClickHouse server,
clickhouse-client, clickhouse-local, ClickHouse Keeper, and other tools: `clickhouse-client`, `clickhouse-local`, ClickHouse Keeper, and other tools:
```bash ```bash
curl https://clickhouse.com/ | sh curl https://clickhouse.com/ | sh
``` ```
1. Run the following command to start the ClickHouse server: 2. Run the following command to start [clickhouse-local](../operations/utilities/clickhouse-local.md):
```bash
./clickhouse
```
`clickhouse-local` allows you to process local and remote files using ClickHouse's powerful SQL and without a need for configuration. Table
data is stored in a temporary location, meaning that after a restart of `clickhouse-local` previously created tables are no longer
available.
As an alternative, you can start the ClickHouse server with this command ...
```bash ```bash
./clickhouse server ./clickhouse server
``` ```
The first time you run this script, the necessary files and folders are created in the current directory, then the server starts. ... and open a new terminal to connect to the server with `clickhouse-client`:
1. Open a new terminal and use the **./clickhouse client** to connect to your service:
```bash ```bash
./clickhouse client ./clickhouse client
@ -54,15 +62,19 @@ On Linux, macOS and FreeBSD:
```response ```response
./clickhouse client ./clickhouse client
ClickHouse client version 23.2.1.1501 (official build). ClickHouse client version 24.5.1.117 (official build).
Connecting to localhost:9000 as user default. Connecting to localhost:9000 as user default.
Connected to ClickHouse server version 23.2.1. Connected to ClickHouse server version 24.5.1.
local-host :) local-host :)
``` ```
You are ready to start sending DDL and SQL commands to ClickHouse! Table data is stored in the current directory and still available after a restart of ClickHouse server. If necessary, you can pass
`-C config.xml` as an additional command line argument to `./clickhouse server` and provide further configuration in a configuration
file. All available configuration settings are documented [here](../operations/settings/settings.md) and in an [example configuration file
template](https://github.com/ClickHouse/ClickHouse/blob/master/programs/server/config.xml).
You are ready to start sending SQL commands to ClickHouse!
:::tip :::tip
The [Quick Start](/docs/en/quick-start.mdx) walks through the steps for creating tables and inserting data. The [Quick Start](/docs/en/quick-start.mdx) walks through the steps for creating tables and inserting data.
@ -377,14 +389,14 @@ build.
### macOS-only: Install with Homebrew ### macOS-only: Install with Homebrew
To install ClickHouse using [homebrew](https://brew.sh/), see [here](https://formulae.brew.sh/cask/clickhouse). To install ClickHouse on macOS using [homebrew](https://brew.sh/), please see the ClickHouse [community homebrew formula](https://formulae.brew.sh/cask/clickhouse).
## Launch {#launch} ## Launch {#launch}
To start the server as a daemon, run: To start the server as a daemon, run:
``` bash ``` bash
$ sudo clickhouse start $ clickhouse start
``` ```
There are also other ways to run ClickHouse: There are also other ways to run ClickHouse: