database bundle

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

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

構文

Shell

codeql database bundle --output=<output> <options>... -- <database>

codeql database bundle --output=<output> <options>... -- <database>

説明

CodeQL データベースの再配置可能なアーカイブを作成します。

データベースの役に立つ部分を圧縮するコマンド。ユーザーが結果、ログ、TRAP などを含める必要があることを明示的に要求しない限り、これには必須コンポーネントのみが含まれます。

[オプション]

主なオプション

`<database>`

[必須] バンドルする CodeQL データベースのパス。

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

[必須] 出力ファイル。通常、拡張子 ".zip" が付きます。

`--[no-]include-diagnostics`

診断をバンドルに含めます。

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

`--[no-]include-results`

事前に計算されたクエリ結果をバンドルに含めます。

`--[no-]include-logs`

ログディレクトリをバンドルに含めます。

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

`--[no-]include-temp`

生成されたパック、クエリ、スイートが置かれている "temp" ディレクトリを含めます。

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

`--[no-]include-uncompressed-source`

非圧縮バージョンのソースアーカイブディレクトリを含めます。これは、従来の CodeQL プラグイン (Eclipse 用 CodeQL など) に必要です。

`--name=<name>`

バンドル内の最上位ディレクトリの名前。指定しないと、既定でデータベースディレクトリの名前になります。

低レベルのデータセットクリーンアップオプション

`--max-disk-cache=<MB>`

中間クエリ結果のディスクキャッシュで使用できる最大容量を設定します。

このサイズが明示的に構成されていない場合、エバリュエーターによって、データセットのサイズとクエリの複雑さに基づき、"妥当な" 量のキャッシュスペースを使うことが試みられます。このデフォルトの使用量よりも高い制限を明示的に設定すると、追加のキャッシュが有効になり、後のクエリが高速化されます。

`--min-disk-free=<MB>`

[詳細設定] ファイルシステムの空き領域の目標量を設定します。

--max-disk-cache が指定されていない場合、ファイルシステムの空き容量がこの値を下回ると、エバリュエーターによってディスクキャッシュの使用量を抑えることが試みられます。

`--min-disk-free-pct=<pct>`

[詳細設定] ファイルシステムの空き領域の目標割合を設定します。

--max-disk-cache が指定されていない場合、ファイルシステムの空き容量がこの割合を下回ると、エバリュエーターはディスクキャッシュの使用量を抑えようとします。

`--cache-cleanup=<mode>`

キャッシュをどの程度積極的にトリミングするかを選びます。以下を選択できます。

clear: キャッシュ全体を削除し、新しく抽出されたデータセットの状態にトリミングします

trim (既定値): 明示的に "キャッシュされた" 述語を除くすべてをトリミングします。__

fit: ディスクキャッシュに対して定義されたサイズ制限を確認し、必要な数の中間ファイルを削除します。

`--cleanup-upgrade-backups`

データベースのアップグレードに起因するすべてのバックアップディレクトリを削除します。

共通オプション

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