dataset import

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

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

構文

Shell

codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...

codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...

説明

[プラミング] TRAP ファイルのセットを生のデータセットにインポートします。

TRAP ファイルを設定してデータセットを作成するか、TRAP ファイルのデータを既存のデータセットに追加します。データセットの更新は、適切な dbscheme があり、その ID プールが初期インポートから保持されている場合にのみ可能です。__

[オプション]

主なオプション

`<dataset>`

[必須] 作成または更新する生の QL データセットへのパス。ディレクトリがまだ存在していない場合は作成されます。

`<trap>...`

インポートする .trap(.gz) ファイルへのパス、または .trap(.gz) ファイルを再帰的にスキャンするディレクトリへのパス。ファイルが指定されていない場合は、空のデータセットが作成されます。

`-S, --dbscheme=<file>`

[必須] インポートする TRAP ファイルを記述する dbscheme 定義。

`-j, --threads=<num>`

インポート操作には、この多くのスレッドを使用します。

既定値は 1 です。 0 を渡して、コンピューター上のコアごとに 1 つのスレッドを使用したり、N を渡して、N 個のコアを未使用のままにしたりすることができます (ただし、その場合でも、少なくとも 1 つのスレッドが使用されます)。

`--[no-]check-undefined-labels`

[詳細設定] 未定義のラベルのエラーを報告します。

`--[no-]check-unused-labels`

[詳細設定] 未使用のラベルのエラーを報告します。

`--[no-]check-repeated-labels`

[詳細設定] 繰り返しラベルのエラーを報告します。

`--[no-]check-redefined-labels`

[詳細設定] 再定義されたラベルのエラーを報告します。

`--[no-]check-use-before-definition`

[詳細設定] 定義される前に使われたラベルのエラーを報告します。

`--[no-]fail-on-trap-errors`

[詳細設定] トラップのインポート中にエラーが発生した場合、0 以外で終了します。

`--[no-]include-location-in-star`

[詳細設定] 元の TRAP ファイル内の場所をエンコードするエンティティ ID を構築します。 TRAP ジェネレーターのデバッグに役立つ場合がありますが、データセット内で多くの領域を占有します。

`--[no-]linkage-aware-import`

[詳細設定] codeql データセットのインポートがリンケージ対応 (既定) かどうかを制御します。データベース作成のこの部分で消費されるメモリが多すぎるプロジェクトでは、このオプションを無効にすると、データベースの完全性が犠牲になりますが、進行しやすくなる場合があります。

v2.15.3 以降で使用できます。

共通オプション

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