dataset check

Note

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

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

構文

Shell

codeql dataset check <options>... -- <dataset>

codeql dataset check <options>... -- <dataset>

説明

[[プラミング] 特定のデータセットで内部整合性を確認します。

このコマンドは、エクストラクターによって生成されたデータを検証するため、CodeQL エクストラクターの開発者にとって最も一般的に役立ちます。また、データベースに対するクエリで矛盾した結果が得られる場合に、基になるデータの issue を原因として除外する場合にも役立つことがあります。

[オプション]

主なオプション

`<dataset>`

[必須] 確認する生の QL データセットへのパス。

`--failing-exitcode=<code>`

[詳細設定] エラーが発生した場合に生成する終了コードを設定します。通常は 1 ですが、出力を解析するツールでは、0 に設定すると有用な場合があります。

`--format=<fmt>`

出力形式を選択します。可能な選択肢:

text (既定値): 人間が判読できるテキストレンダリング。__

json: オブジェクトのストリーミングされた JSON 配列。

jsonz: 0 で終わる JSON オブジェクトのストリーム。

`--[no-]precise-locations`

[詳細設定] 不整合の正確な場所を計算するためにさらに労力を費やします。これには時間がかかりますが、エクストラクターの動作をデバッグしやすくなる可能性があります。

`--max-resolve-depth=<n>`

[[詳細設定] 不整合を説明するために ID を解決する必要がある最大深度 (既定値: 3)。

`--max-errors-per-checker=<n>`

明示的に報告する必要がある各種類の不整合エラーの最大数 (既定値: 5)

共通オプション

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