Windows ユーザーClickHouse は Linux と macOS 上でネイティブに動作します。Windows では、これらの手順を
Windows Subsystem for Linux (WSL)
内で実行してください。
clickhousectl、別名 chctl) を使用すると、ローカルの ClickHouse バージョンの
インストールと管理、ローカルの ClickHouse サーバーおよび Postgres サーバーの実行、クエリの実行、
ClickHouse Cloud の管理を行えます。このページでは、CLI のインストールから、
ローカルの ClickHouseサーバーの起動、サーバーへの接続までの手順を説明します。
クイックインストール
スクリプトを使用した場合、clickhousectl はすでにインストールされているため、
ClickHouse をインストールする に進んでください。
1
ClickHouse CLI をインストールする
インストールスクリプトは、x86_64 および ARM64 アーキテクチャの macOS と Linux に対応しています:このスクリプトは
CLI の新しいリリースを確認してインストールするには、次のコマンドを実行します。
clickhousectl を ~/.local/bin にインストールし、同じ場所に chctl
という別名を作成します。~/.local/bin が PATH に含まれていない旨がスクリプトから表示された場合は、PATH に追加してください。
また、今後のセッションでも有効になるよう、同じ行をシェルのプロファイル (~/.bashrc、~/.zshrc) にも追加してください:その他のインストール方法
その他のインストール方法
chctl という別名が作成されるのは、インストールスクリプトまたは npm を使用した場合のみです。2
ClickHouse をインストール
ClickHouse の最新バージョンをインストールし、デフォルトとして設定します。ダウンロード可能なマイナーバージョンと、インストール済みのバージョンを確認するには、次のコマンドを実行します。
local use は、指定したバージョンがまだインストールされていなければインストールし、それをデフォルトとして設定したうえで、~/.local/bin に clickhouse のシンボリックリンクを作成します。これにより、clickhouse バイナリを直接実行できるようになります。~/.local/bin が PATH に含まれていれば、本ドキュメントの以降の手順で実行する
clickhouse コマンドはそのまま動作します。最新の長期サポート (LTS) リリースや、特定の
バージョンを選択することもできます。use と install の違い
clickhousectl local use <version> はバージョンをインストールしたうえでデフォルトに設定し、
clickhouse シンボリックリンクも更新します。一方、clickhousectl local install <version>
はバージョンをダウンロードするだけです。デフォルトがまだ設定されていない場合に限りそのバージョンがデフォルトになりますが、
シンボリックリンクは更新されません。シンボリックリンクを作成・
更新せずにデフォルトを設定するには、clickhousectl local use <version> --no-global を使用します。3
clickhouse-serverを起動する
clickhousectl は、ローカルサーバーを実行したディレクトリ単位で管理します。プロジェクト用の
ディレクトリを作成し、そこでサーバーを起動します:default になります。データは
./.clickhouse/ に保存されるため、以降の clickhousectl local コマンドは同じ
ディレクトリで実行してください。clickhousectl は親ディレクトリを検索しません。サーバーは
HTTP ポート 8123 と TCP ポート 9000 で待ち受けます。これらのポートが使用中の場合は、空いているポートが使われます。
ポートを指定するには、--http-port と --tcp-port を指定します。複数の
サーバーを実行する場合は、clickhousectl local server start dev のように、それぞれに名前を付けてください。サーバーが実行中であることを確認するには、次のコマンドを実行します。4
clickhouse-client を起動する
同じディレクトリで これで ClickHouse に SQL コマンドを送信する準備が整いました。クライアントを終了するには
clickhouse-client を使用してサーバーに接続します:local client は default という名前のサーバーに接続し、サーバーと同じ
ClickHouse バージョンを使用します。別のサーバーに接続するには、clickhousectl local client dev のようにサーバー名を指定します。次のような出力が表示されます。exit と入力します。対話型セッションを開かずに単一のクエリを実行するには、-q を指定します。5
サーバーを停止する
サーバーは停止するまでバックグラウンドで動作し続けます。停止するには、同じディレクトリで
次のコマンドを実行します:停止してもサーバーのデータは保持されるため、次回
clickhousectl local server start を実行した際にそのまま利用できます。次のステップ
-
Postgres をローカルで実行する。 Docker を起動した状態で、ローカルの Postgres サーバーを起動し、
psqlで接続します。 -
ClickHouse Cloud に接続する。 アカウントを作成するか、既存のアカウントにログインします。
ブラウザログインは読み取り専用です。Cloud リソースを作成・変更するには
APIキーが必要です。
clickhousectl cloud auth login --interactiveを実行すると、APIキーの入力を求められます。 -
CLI のその他の機能を確認する。 clickhousectl リファレンスを参照するか、
clickhousectl --helpを実行してください。