bqrs 情報

メモ

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

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

概要

Shell

codeql bqrs info <options>... -- <file>

codeql bqrs info <options>... -- <file>

Description

BQRS ファイルのメタデータを表示します。

このコマンドは、クエリの実行結果であるコンパクトバイナリ BQRS ファイルに含まれるデータの概要を表示します。 BQRS ファイル内の各結果セット (テーブル) の名前とサイズ、および各結果セットの列の型が表示されます。

また、必要に応じて、codeql bqrs decode の改ページオプションを使うためのオフセットを、事前に計算することもできます。これは主に IDE プラグインに役立ちます。

オプション

主なオプション

`<file>`

          \[必須] 情報を表示する BQRS ファイル。

`--format=<fmt>`

出力形式 (text(既定値) または json) を選びます。

codeql bqrs decode での改ページのサポート

`--paginate-rows=<num>`

          \[詳細設定] `--format=json` と共に指定すると、バイト オフセットのテーブルを計算します。後でそれを `--start-at` の [](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) オプションに指定して、0、 _\<num>_ 、2\*_\<num>_ などの位置から結果のストリーミングを開始できます。

`--paginate-result-set=<name>`

          \[詳細設定] この名前の結果セットについてのみ `--paginate-rows` を処理します。 (名前がどの結果セットとも一致しない場合、`--paginate-rows` では何も行われません)。

共通オプション

`-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` 以降で使用できます。

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

この記事の内容

概要