bqrs をデコードする

メモ

このコンテンツでは、CodeQL CLI の最新リリースについて説明します。このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。

以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。

概要

Shell

codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>

codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>

Description

結果データを BQRS から他の形式に変換します。

          `--output` オプションが指定されていない場合、デコードされた出力は標準出力に書き込まれます。

オプション

主なオプション

`<file>`

          \[必須] デコードする BQRS ファイル。

`-o, --output=<file>`

目的の出力の書き込み先のファイル。

`-r, --result-set=<name>`

デコードする BQRS ファイルから特定の結果セットを選びます。使用できる結果セットの一覧は、codeql bqrs info を使って表示できます。

結果セットを選ばないと、選んだ出力形式と処理オプションでサポートされている場合は、すべての結果セットがデコードされます。そうでない場合は、エラーになります。

`-k, --sort-key=<col>[,<col>...]`

選んだ結果セットを、指定した列で並べ替えます。

`--sort-direction=<direction>[,<direction>...]`

指定した並べ替えの方向を使って、選んだ結果セットを並べ替えます。

並べ替えの方向を指定しないと、すべての列で昇順が使われます。

出力形式のオプション

`--format=<fmt>`

出力形式を選びます。以下を選択できます。

          `text` (既定値): 人間が判読できるプレーンテキストのテーブル。__

          `csv`: コンマ区切りの値。

          `json`: ストリーミング JSON。

          `bqrs`: BQRS。 これは `--output` と一緒に使う必要があります。 
          `--sort-key` と併用すると最も役に立ちます。

`--no-titles`

          `text` と `csv` 形式で列のタイトルを省略します

`--entities=<fmt>[,<fmt>...]`

          \[詳細設定] エンティティ型の結果列の表示方法を制御します。 次の選択肢のコンマ区切りの一覧:

          `url`: ソースの場所を参照する URL (エンティティ型に対してこのような URL を生成するようにクエリがコンパイルされた場合)。

          `string`: QL の toString() メソッドによって計算された文字列。列に対してこのような文字列を生成するようにクエリがコンパイルされた場合。

          `id`: エンティティの内部 ID。役に立たない可能性があります。

          `all`: BQRS ファイルが提供するすべての情報を含む列を示します。

可能であれば、選んだすべてのオプションが示されます。

ページ分割のオプション (対話型フロントエンドで使用する場合)

`--rows=<num>`

          \[詳細設定] 選んだ結果セットの先頭から、または `--start-at` で指定した場所から、この数の行を出力します。

`--start-at=<offset>`

          \[詳細設定] BQRS ファイル内の特定のバイト オフセットで定義された行の印刷を始めます。 オフセットは、[codeql bqrs info](/code-security/codeql-cli/codeql-cli-manual/bqrs-info) から、または `--rows` が設定された前の呼び出しからの JSON 出力で見つかる "next" ポインターから、取得する必要があります。 その他のオフセットでは、意味のない出力や明示的なエラーが発生する可能性があります。

常に --rows と共に使う必要があり、--sort-key とは互換性がありません。

共通オプション

`-h, --help`

このヘルプテキストを表示します。

`-J=<opt>`

          \[詳細設定] コマンドを実行している JVM にオプションを指定します

(スペースを含むオプションは正しく処理されないことに注意してください)。

`-v, --verbose`

出力される進行状況メッセージの数を段階的に増やします。

`-q, --quiet`

出力される進行状況メッセージの数を段階的に減らします。

`--verbosity=<level>`

          \[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 
          `-v` と `-q` がオーバーライドされます。

`--logdir=<dir>`

          \[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます

(完全に制御できる名前でログファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。

`--common-caches=<dir>`

          \[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、デフォルトではユーザーのホーム ディレクトリに名前が付けられた `.codeql` ディレクトリになります。まだ存在しない場合は作成されます。

          `v2.15.2` 以降で使用できます。

この機能を使用できるユーザーについて

この記事の内容

概要