clickhouse-local と ClickHouse の使い分け
clickhouse-local は、開発者が SQL を使用してローカルおよびリモートファイルに対して迅速な処理を行うための使いやすい ClickHouse のバージョンであり、完全なデータベースサーバーをインストールする必要がありません。clickhouse-local を使用することで、開発者はコマンドラインから直接 ClickHouse SQL ダイアレクト を用いて SQL コマンドを実行でき、フル ClickHouse インストールの必要なしに ClickHouse の機能に簡単かつ効率的にアクセスできます。clickhouse-local の主な利点の1つは、clickhouse-client をインストールする際に既に含まれていることです。これにより、開発者は複雑なインストールプロセスなしに clickhouse-local を迅速に始めることができます。
clickhouse-local は開発とテスト用、ファイル処理には優れたツールですが、エンドユーザーやアプリケーションにサービスを提供するには適していません。これらのシナリオでは、オープンソースの ClickHouse を使用することを推奨します。ClickHouse は、大規模な分析ワークロードを処理するために設計された強力な OLAP データベースです。大規模データセットに対する複雑なクエリの迅速かつ効率的な処理が提供され、性能が重要な本番環境での使用に最適です。さらに、ClickHouse はレプリケーション、シャーディング、高可用性などの広範な機能を提供し、大規模データセットを処理しアプリケーションにサービスを提供するために必要です。大きなデータセットを扱ったり、エンドユーザーやアプリケーションにサービスを提供する必要がある場合は、clickhouse-local の代わりにオープンソースの ClickHouse を使用することをお勧めします。
以下のドキュメントを参照して、clickhouse-local の例として ローカルファイルのクエリ や S3 にある Parquet ファイルの読み取り などの使用例を確認してください。
clickhouse-local のダウンロード
clickhouse-local は、ClickHouse サーバーおよび clickhouse-client を実行する同じ clickhouse バイナリを使用して実行されます。最新バージョンをダウンロードする最も簡単な方法は、次のコマンドを使用することです。
curl https://clickhouse.com/ | sh
注記
ダウンロードしたバイナリは、さまざまな ClickHouse ツールやユーティリティを実行できます。ClickHouse をデータベースサーバーとして実行したい場合は、クイックスタート をご覧ください。
SQL を使用してファイル内のデータをクエリする
clickhouse-local の一般的な使用法は、ファイルに対してアドホッククエリを実行することです。つまり、データをテーブルに挿入する必要はありません。clickhouse-local は、ファイルからデータをストリーミングして一時テーブルに変換し、SQL を実行できます。
ファイルが clickhouse-local と同じマシンにある場合は、単に読み込むファイルを指定するだけです。以下の reviews.tsv ファイルは、Amazon の商品レビューのサンプリングを含んでいます：
./clickhouse local -q "SELECT * FROM 'reviews.tsv'"
このコマンドは次のようにショートカットできます：
./clickhouse local -q "SELECT * FROM file('reviews.tsv')"
ClickHouse は、ファイル名拡張子からファイルがタブ区切り形式であることを認識します。形式を明示的に指定する必要がある場合は、単に 多くの ClickHouse 入力形式 のいずれかを追加してください：
./clickhouse local -q "SELECT * FROM file('reviews.tsv', 'TabSeparated')"
file テーブル関数はテーブルを作成し、DESCRIBE を使用して推論されたスキーマを見ることができます：
./clickhouse local -q "DESCRIBE file('reviews.tsv')"
ヒント
ファイル名にグロブを使用することが許可されています（グロブ置換 を参照）。
例：
./clickhouse local -q "SELECT * FROM 'reviews*.jsonl'"
./clickhouse local -q "SELECT * FROM 'review_?.csv'"
./clickhouse local -q "SELECT * FROM 'review_{1..3}.csv'"
marketplace Nullable(String)
customer_id Nullable(Int64)
review_id Nullable(String)
product_id Nullable(String)
product_parent Nullable(Int64)
product_title Nullable(String)
product_category Nullable(String)
star_rating Nullable(Int64)
helpful_votes Nullable(Int64)
total_votes Nullable(Int64)
vine Nullable(String)
verified_purchase Nullable(String)
review_headline Nullable(String)
review_body Nullable(String)
review_date Nullable(Date)
最高評価の商品の調査をしましょう：
./clickhouse local -q "SELECT
argMax(product_title,star_rating),
max(star_rating)
FROM file('reviews.tsv')"
Monopoly Junior Board Game 5
AWS S3 にある Parquet ファイル内のデータをクエリする
S3 にファイルがある場合は、clickhouse-local および s3 テーブル関数を使用して、ClickHouse テーブルにデータを挿入することなく、その場でファイルをクエリできます。私たちのパブリックバケットには、イギリスで売却された物件の価格を含む house_0.parquet というファイルがあります。行数を見てみましょう：
./clickhouse local -q "
SELECT count()
FROM s3('https://datasets-documentation.s3.eu-west-3.amazonaws.com/house_parquet/house_0.parquet')"
ファイルには 2.7M の行があります：
ClickHouse がファイルから判断する推論されたスキーマを見るのは常に便利です：
./clickhouse local -q "DESCRIBE s3('https://datasets-documentation.s3.eu-west-3.amazonaws.com/house_parquet/house_0.parquet')"
price Nullable(Int64)
date Nullable(UInt16)
postcode1 Nullable(String)
postcode2 Nullable(String)
type Nullable(String)
is_new Nullable(UInt8)
duration Nullable(String)
addr1 Nullable(String)
addr2 Nullable(String)
street Nullable(String)
locality Nullable(String)
town Nullable(String)
district Nullable(String)
county Nullable(String)
最も高価な地域を見てみましょう：
./clickhouse local -q "
SELECT
town,
district,
count() AS c,
round(avg(price)) AS price,
bar(price, 0, 5000000, 100)
FROM s3('https://datasets-documentation.s3.eu-west-3.amazonaws.com/house_parquet/house_0.parquet')
GROUP BY
town,
district
HAVING c >= 100
ORDER BY price DESC
LIMIT 10"
LONDON CITY OF LONDON 886 2271305 █████████████████████████████████████████████▍
LEATHERHEAD ELMBRIDGE 206 1176680 ███████████████████████▌
LONDON CITY OF WESTMINSTER 12577 1108221 ██████████████████████▏
LONDON KENSINGTON AND CHELSEA 8728 1094496 █████████████████████▉
HYTHE FOLKESTONE AND HYTHE 130 1023980 ████████████████████▍
CHALFONT ST GILES CHILTERN 113 835754 ████████████████▋
AMERSHAM BUCKINGHAMSHIRE 113 799596 ███████████████▉
VIRGINIA WATER RUNNYMEDE 356 789301 ███████████████▊
BARNET ENFIELD 282 740514 ██████████████▊
NORTHWOOD THREE RIVERS 184 731609 ██████████████▋
ヒント
ファイルを ClickHouse に挿入する準備ができたら、ClickHouse サーバーを起動し、file および s3 テーブル関数の結果を MergeTree テーブルに挿入します。詳細については、クイックスタート を参照してください。
clickhouse-local を使用して、さまざまな形式の間でデータを変換できます。例：
$ clickhouse-local --input-format JSONLines --output-format CSV --query "SELECT * FROM table" < data.json > data.csv
形式はファイル拡張子から自動的に検出されます：
$ clickhouse-local --query "SELECT * FROM table" < data.json > data.csv
ショートカットとして、--copy 引数を使用して書くこともできます：
$ clickhouse-local --copy < data.json > data.csv
使用法
デフォルトでは clickhouse-local は、同じホスト上の ClickHouse サーバーのデータにアクセスでき、サーバーの設定には依存しません。また、--config-file 引数を使用してサーバー設定を読み込むこともサポートしています。一時データについては、デフォルトでユニークな一時データディレクトリが作成されます。
基本的な使用法 (Linux):
$ clickhouse-local --structure "table_structure" --input-format "format_of_incoming_data" --query "query"
基本的な使用法 (Mac):
$ ./clickhouse local --structure "table_structure" --input-format "format_of_incoming_data" --query "query"
注記
clickhouse-local は WSL2 を通じて Windows でもサポートされています。
引数：
-S, --structure — 入力データのテーブル構造。--input-format — 入力形式、デフォルトは TSV です。-F, --file — データパス、デフォルトは stdin です。-q, --query — 実行するクエリ、； で区切られます。--query は複数回指定可能です（例： --query "SELECT 1" --query "SELECT 2"）。--queries-file と同時に使用することはできません。--queries-file - 実行するクエリのファイルパス。--queries-file は複数回指定でき、例： --query queries1.sql --query queries2.sql とすることができます。--query と同時には使用できません。--multiquery, -n – 指定した場合、セミコロンで区切られた複数のクエリを --query オプションの後にリストできます。便利のため、--query を省略して、--multiquery の後にクエリを直接渡すことも可能です。-N, --table — 出力データを置くテーブル名、デフォルトは table です。-f, --format, --output-format — 出力形式、デフォルトは TSV です。-d, --database — デフォルトのデータベース、デフォルトは _local です。--stacktrace — 例外が発生した場合にデバッグ出力をダンプするかどうか。--echo — 実行前にクエリを印刷します。--verbose — クエリ実行の詳細情報。--logger.console — コンソールにログを記録。--logger.log — ログファイル名。--logger.level — ログレベル。--ignore-error — クエリが失敗しても処理を停止しない。-c, --config-file — ClickHouse サーバーと同じ形式の設定ファイルのパス。デフォルトでは設定が空です。--no-system-tables — システムテーブルをアタッチしない。--help — clickhouse-local 用の引数リファレンス。-V, --version — バージョン情報を印刷して終了します。
また、--config-file の代わりにより一般的に使用される各 ClickHouse 設定変数用の引数もあります。
$ echo -e "1,2\n3,4" | clickhouse-local --structure "a Int64, b Int64" \
--input-format "CSV" --query "SELECT * FROM table"
Read 2 rows, 32.00 B in 0.000 sec., 5182 rows/sec., 80.97 KiB/sec.
1 2
3 4
前の例は次のように同じです：
$ echo -e "1,2\n3,4" | clickhouse-local -n --query "
CREATE TABLE table (a Int64, b Int64) ENGINE = File(CSV, stdin);
SELECT a, b FROM table;
DROP TABLE table;"
Read 2 rows, 32.00 B in 0.000 sec., 4987 rows/sec., 77.93 KiB/sec.
1 2
3 4
stdin や --file 引数を使用する必要はなく、file テーブル関数を使用して任意の数のファイルを開くことができます：
$ echo 1 | tee 1.tsv
1
$ echo 2 | tee 2.tsv
2
$ clickhouse-local --query "
select * from file('1.tsv', TSV, 'a int') t1
cross join file('2.tsv', TSV, 'b int') t2"
1 2
Unix ユーザーごとのメモリ使用量を出力しましょう。
クエリ：
$ ps aux | tail -n +2 | awk '{ printf("%s\t%s\n", $1, $4) }' \
| clickhouse-local --structure "user String, mem Float64" \
--query "SELECT user, round(sum(mem), 2) as memTotal
FROM table GROUP BY user ORDER BY memTotal DESC FORMAT Pretty"
結果：
Read 186 rows, 4.15 KiB in 0.035 sec., 5302 rows/sec., 118.34 KiB/sec.
┏━━━━━━━━━━┳━━━━━━━━━━┓
┃ user ┃ memTotal ┃
┡━━━━━━━━━━╇━━━━━━━━━━┩
│ bayonet │ 113.5 │
├──────────┼──────────┤
│ root │ 8.8 │
├──────────┼──────────┤
...
関連コンテンツ
