From 15eac2513ba4d716618256d85488c7ae4f1dd2b1 Mon Sep 17 00:00:00 2001 From: Robert Schulze Date: Thu, 2 May 2024 10:09:17 +0000 Subject: [PATCH 1/3] Docs: Update install instructions --- docs/en/getting-started/install.md | 56 ++++++++++++++++++------------ 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/docs/en/getting-started/install.md b/docs/en/getting-started/install.md index e3be30bde8c..d028301f08e 100644 --- a/docs/en/getting-started/install.md +++ b/docs/en/getting-started/install.md @@ -11,7 +11,7 @@ import CodeBlock from '@theme/CodeBlock'; # 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 - **[Quick Install](#quick-install):** an easy-to-download binary for testing and developing with ClickHouse @@ -32,37 +32,49 @@ 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 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 - curl https://clickhouse.com/ | sh - ``` + ```bash + 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` all previously created tables are no longer + available. + + As an alternative, you can start the ClickHouse server with this command ... ```bash ./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 and use `clickhouse-client` to connect to the server: -1. Open a new terminal and use the **./clickhouse client** to connect to your service: + ```bash + ./clickhouse client + ``` - ```bash - ./clickhouse client - ``` + ```response + ./clickhouse client + ClickHouse client version 24.5.1.117 (official build). + Connecting to localhost:9000 as user default. + Connected to ClickHouse server version 24.5.1. - ```response - ./clickhouse client - ClickHouse client version 23.2.1.1501 (official build). - Connecting to localhost:9000 as user default. - Connected to ClickHouse server version 23.2.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 availabe configuration settings are documented [here](../operations/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 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 -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} To start the server as a daemon, run: ``` bash -$ sudo clickhouse start +$ clickhouse start ``` There are also other ways to run ClickHouse: From d2a3ffbe57c5c2b06800878e0c3ce57572cee317 Mon Sep 17 00:00:00 2001 From: Robert Schulze Date: Thu, 2 May 2024 11:08:17 +0000 Subject: [PATCH 2/3] Typo --- docs/en/getting-started/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/getting-started/install.md b/docs/en/getting-started/install.md index d028301f08e..dc4d73cd13b 100644 --- a/docs/en/getting-started/install.md +++ b/docs/en/getting-started/install.md @@ -71,7 +71,7 @@ On Linux, macOS and FreeBSD: 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 availabe configuration settings are documented [here](../operations/settings.md) and in an [example configuration file + file. All available configuration settings are documented [here](../operations/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! From 2c34e4b65051df15e93a74c07e03d48e585587ce Mon Sep 17 00:00:00 2001 From: Robert Schulze Date: Thu, 2 May 2024 14:42:58 +0200 Subject: [PATCH 3/3] Fix links --- docs/en/getting-started/install.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/en/getting-started/install.md b/docs/en/getting-started/install.md index dc4d73cd13b..6525c29306a 100644 --- a/docs/en/getting-started/install.md +++ b/docs/en/getting-started/install.md @@ -45,7 +45,7 @@ On Linux, macOS and FreeBSD: ``` `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` all previously created tables are no longer + 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 ... @@ -54,7 +54,7 @@ On Linux, macOS and FreeBSD: ./clickhouse server ``` - ... and open a new terminal and use `clickhouse-client` to connect to the server: + ... and open a new terminal to connect to the server with `clickhouse-client`: ```bash ./clickhouse client @@ -71,7 +71,7 @@ On Linux, macOS and FreeBSD: 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.md) and in an [example configuration file + 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!