ClickHouse/docs/ja/interfaces/cli.md

150 lines
9.5 KiB
Markdown
Raw Normal View History

2020-04-04 09:15:31 +00:00
---
machine_translated: true
machine_translated_rev: 72537a2d527c63c07aa5d2361a8829f3895cf2bd
2020-04-04 09:15:31 +00:00
toc_priority: 17
toc_title: "\u30B3\u30DE\u30F3\u30C9\u884C\u30AF\u30E9\u30A4\u30A2\u30F3\u30C8"
2020-04-04 09:15:31 +00:00
---
# コマンド行クライアント {#command-line-client}
2020-04-04 09:15:31 +00:00
ClickHouseスネイティブコマンドラインのクライアント: `clickhouse-client`. クライア 詳細については、 [設定](#interfaces_cli_configuration).
2020-04-04 09:15:31 +00:00
[インスト](../getting-started/index.md) それから `clickhouse-client` パッケージ化し、コマンドで実行します `clickhouse-client`.
2020-04-04 09:15:31 +00:00
``` bash
$ clickhouse-client
ClickHouse client version 19.17.1.1579 (official build).
Connecting to localhost:9000 as user default.
Connected to ClickHouse server version 19.17.1 revision 54428.
:)
```
異なるクライアントとサーババージョンと互換性が、一部機能が利用できない古いクライアント. お使いになることをお勧めしま同じバージョンのクライアントのサーバーアプリです。 古いバージョンのクライアントを使用しようとすると、サーバー, `clickhouse-client` メッセージを表示する:
2020-04-04 09:15:31 +00:00
ClickHouse client version is older than ClickHouse server. It may lack support for new features.
## 使用法 {#cli_usage}
2020-04-04 09:15:31 +00:00
クライアントは、対話型および非対話型(バッチ)モードで使用できます。 バッチモードを使用するには、 query 変数は、またはデータをに送ります stdin (これは、 stdin は端末ではない)、またはその両方。 HTTPインターフェイスと同様に、 query 変数およびデータをに送ります stdin は、リクエストの連結である。 query パラメータ、改行、およびデータ stdin. これは、大規模なINSERTクエリに便利です。
2020-04-04 09:15:31 +00:00
クライアントを使用してデータを挿入する例:
``` bash
$ echo -ne "1, 'some text', '2016-08-14 00:00:00'\n2, 'some more text', '2016-08-14 00:00:01'" | clickhouse-client --database=test --query="INSERT INTO test FORMAT CSV";
$ cat <<_EOF | clickhouse-client --database=test --query="INSERT INTO test FORMAT CSV";
3, 'some text', '2016-08-14 00:00:00'
4, 'some more text', '2016-08-14 00:00:01'
_EOF
$ cat file.csv | clickhouse-client --database=test --query="INSERT INTO test FORMAT CSV";
```
バッチモードでは、デフォルトのデータ形式はTabSeparatedです。 クエリのFORMAT句で書式を設定できます。
2020-04-04 09:15:31 +00:00
既定では、バッチモードでのみ単一のクエリを処理できます。 複数のクエリを作成するには “script,” 使用する `--multiquery` パラメータ。 このため、すべてのクエリを除をサポートしていません。 クエリ結果は、追加の区切り文字なしで連続して出力されます。 同様に、多数のクエリを処理するには、次のように実行できます clickhouse-client 各クエリに対して。 起動には数十ミリ秒かかることに注意してください。 clickhouse-client プログラム
2020-04-04 09:15:31 +00:00
対話モードでは、クエリを入力できるコマンドラインを取得します。
2020-04-04 09:15:31 +00:00
もし multiline 指定されていない(デフォルト):クエリを実行するには、Enterキーを押します。 クエリの最後にセミコロンは必要ありません。 複数行のクエリを入力するには、円記号を入力します `\` ラインフィードの前に。 Enterキーを押すと、クエリの次の行を入力するように求められます。
2020-04-04 09:15:31 +00:00
複数行が指定されている場合:クエリを実行するには、セミコロンで終了し、Enterキーを押します。 入力した行の最後にセミコロンが省略されている場合は、クエリの次の行を入力するよう求められます。
2020-04-04 09:15:31 +00:00
単一のクエリのみが実行されるため、セミコロンの後のすべてが無視されます。
2020-04-04 09:15:31 +00:00
以下を指定できます `\G` セミコロンの代わりに、またはその後。 これは、垂直形式を示します。 この形式では、各値は別々の行に印刷されます。 この異常な機能は、MySQL CLIとの互換性のために追加されました。
2020-04-04 09:15:31 +00:00
のコマンドラインに基づく replxx (類似 readline). つまり、使い慣れたキーボードショートカットを使用し、履歴を保持します。 歴史はに書かれています `~/.clickhouse-client-history`.
2020-04-04 09:15:31 +00:00
既定では、使用される形式はPrettyCompactです。 クエリのFORMAT句で書式を変更するか、次のように指定することができます `\G` クエリの最後に、 `--format` または `--vertical` コマンドラインでの引数、またはクライアント構成ファイルの使用。
2020-04-04 09:15:31 +00:00
2020-12-16 16:58:00 +00:00
クライアントを終了するには、Ctrl+Dを押すか、クエリの代わりに次のいずれかを入力します: “exit”, “quit”, “logout”, “exit;”, “quit;”, “logout;”, “q”, “Q”, “:q”
2020-04-04 09:15:31 +00:00
が処理クエリー、クライアントを示し:
1. (デフォルトでは)毎秒10回を超えないように更新されます。 クイッククエリの場合、進行状況を表示する時間がない場合があります。
2. 解析後、デバッグ用に書式設定されたクエリ。
2020-04-04 09:15:31 +00:00
3. 指定された形式の結果。
4. 結果の行数、経過した時間、およびクエリ処理の平均速度。
2020-04-04 09:15:31 +00:00
ただし、サーバーが要求を中止するのを少し待つ必要があります。 特定の段階でクエリをキャンセルすることはできません。 もう一度待ってCtrl+Cを押さないと、クライアントは終了します。
2020-04-04 09:15:31 +00:00
コマンドライ 詳細については “External data for query processing”.
2020-04-04 09:15:31 +00:00
### パラメー {#cli-queries-with-parameters}
2020-04-04 09:15:31 +00:00
を作成でき、クエリパラメータおよびパスの値からのお知らクライアントアプリケーション. これを避けるフォーマットのクエリが特定の動的価値観にクライアント側で行われます。 例えば:
``` bash
$ clickhouse-client --param_parName="[1, 2]" -q "SELECT * FROM table WHERE a = {parName:Array(UInt16)}"
```
#### クエリ構文 {#cli-queries-with-parameters-syntax}
2020-04-04 09:15:31 +00:00
通常どおりにクエリを書式設定し、アプリパラメータからクエリに渡す値を次の形式の中かっこで囲みます:
2020-04-04 09:15:31 +00:00
``` sql
{<name>:<data type>}
```
- `name` — Placeholder identifier. In the console client it should be used in app parameters as `--param_<name> = value`.
- `data type` — [データ型](../sql-reference/data-types/index.md) アプリのパラメータ値の たとえば、次のようなデータ構造 `(integer, ('string', integer))` を持つことができ `Tuple(UInt8, Tuple(String, UInt8))` データ型(別のデータ型も使用できます [整数](../sql-reference/data-types/int-uint.md) タイプ)。
2020-04-04 09:15:31 +00:00
#### 例 {#example}
2020-04-04 09:15:31 +00:00
``` bash
$ clickhouse-client --param_tuple_in_tuple="(10, ('dt', 10))" -q "SELECT * FROM table WHERE val = {tuple_in_tuple:Tuple(UInt8, Tuple(String, UInt8))}"
```
## 設定 {#interfaces_cli_configuration}
パラメータを渡すには `clickhouse-client` (すべてのパラメータには既定値があります):
2020-04-04 09:15:31 +00:00
- コマンドラインから
コマンドラインオプションは、構成ファイルの既定値と設定を上書きします。
- 設定ファイル。
2020-04-04 09:15:31 +00:00
構成ファイルの設定は、既定値を上書きします。
2020-04-04 09:15:31 +00:00
### コマンドライ {#command-line-options}
2020-04-04 09:15:31 +00:00
- `--host, -h` - The server name, localhost デフォルトでは。 名前またはIPv4またはIPv6アドレスを使用できます。
2020-04-04 09:15:31 +00:00
- `--port` The port to connect to. Default value: 9000. Note that the HTTP interface and the native interface use different ports.
- `--user, -u` The username. Default value: default.
- `--password` The password. Default value: empty string.
- `--query, -q` The query to process when using non-interactive mode.
- `--database, -d` Select the current default database. Default value: the current database from the server settings (default デフォルトでは)。
- `--multiline, -m` If specified, allow multiline queries (do not send the query on Enter).
- `--multiquery, -n` If specified, allow processing multiple queries separated by semicolons.
- `--format, -f` Use the specified default format to output the result.
- `--vertical, -E` If specified, use the Vertical format by default to output the result. This is the same as format=Vertical. この形式では、各値は別々の行に印刷されます。
- `--time, -t` If specified, print the query execution time to stderr 非対話型モードで。
2020-04-04 09:15:31 +00:00
- `--stacktrace` If specified, also print the stack trace if an exception occurs.
- `--config-file` The name of the configuration file.
- `--secure` If specified, will connect to server over secure connection.
- `--param_<name>` — Value for a [パラメー](#cli-queries-with-parameters).
2020-04-04 09:15:31 +00:00
### 設定ファイル {#configuration_files}
`clickhouse-client` 次の最初の既存のファイルを使用します:
- で定義される。 `--config-file` パラメータ。
2020-04-04 09:15:31 +00:00
- `./clickhouse-client.xml`
- `~/.clickhouse-client/config.xml`
- `/etc/clickhouse-client/config.xml`
設定ファイルの例:
``` xml
<config>
<user>username</user>
<password>password</password>
<secure>False</secure>
</config>
```
[元の記事](https://clickhouse.tech/docs/en/interfaces/cli/) <!--hide-->