database upgrade

Note

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

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

構文

Shell

codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>

codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>

説明

データベースをアップグレードして、現在のツールで使用できるようにします。

これにより、必要に応じて、QL パックの検索パスにある QL ライブラリと互換性を持つように CodeQL データベースが書き換えられます。

アップグレードが必要な場合、元に戻すことはできません。その後、データベースは作成時に最新であったライブラリで使用できなくなります。

[オプション]

主なオプション

`<database>`

[必須] アップグレードする CodeQL データベースのパス。

`--search-path=<dir>[:<dir>...]`

アップグレードレシピを含む QL パックが見つかる可能性があるディレクトリの一覧。各ディレクトリは、QL パック (またはルートに .codeqlmanifest.json ファイルを含むパックのバンドル)、または 1 つ以上のこのようなディレクトリの直接の親ディレクトリのいずれかです。

パスにディレクトリツリーを含める場合は、それらの順序で、それらの間の優先順位を定義します。解決する必要があるパック名が複数のディレクトリツリーで一致する場合は、最初に指定したものが優先されます。

オープンソースの CodeQL リポジトリのチェックアウトでこれを指定すると、そこにある言語の 1 つを照会するときに機能するはずです。

(注: Windows では、パスの区切り記号は ; です)。

`--additional-packs=<dir>[:<dir>...]`

[詳細設定] このディレクトリリストを指定した場合、ディレクトリは、--search-path で指定したものより前に、アップグレードについて検索されます。これらの間の順序は重要ではありません。この一覧の 2 つの異なる場所でパック名が見つかった場合はエラーです。

これは、既定のパスにも表示されるパックの新しいバージョンを一時的に開発している場合に役立ちます。一方、構成ファイルでこのオプションをオーバーライドすることは "お勧めしません"。内部アクションによっては、このオプションがオンザフライで追加され、構成済みの値がオーバーライドされます。__

(注: Windows では、パスの区切り記号は ; です)。

`--target-dbscheme=<file>`

アップグレード先である "ターゲット" の dbscheme。__ これを指定しない場合、最大アップグレードパスが構築されます

`--target-sha=<sha>`

[詳細設定] --target-dbscheme の代替手段で、dbscheme ファイルではなくターゲットの dbscheme の内部ハッシュを提供します。

`--[no-]allow-downgrades`

アップグレードがない場合に重要なダウングレードを含めます

アップグレードクエリの評価を制御するためのオプション

`--[no-]tuple-counting`

[詳細設定] クエリエバリュエーターログの各評価ステップのタプル数を表示します。 --evaluator-log オプションを指定すると、コマンドで生成されるテキストベースのログと構造化された JSON ログの両方にタプル数が含まれます (これは、複雑な QL コードのパフォーマンス最適化に役立ちます)。

`--timeout=<seconds>`

[詳細設定] クエリ評価のタイムアウトの長さを秒単位で設定します。

タイムアウト機能は、複雑なクエリの評価に "かなり長い時間" がかかるケースを検出することを目的としています。クエリの評価にかかる合計時間を制限するのは効果的な方法ではありません。評価は、計算の個別に時間指定された各部分がタイムアウト内に完了する限り続行できます。現在、これらの個別に時間指定された部分は、最適化されたクエリの "RA レイヤー" ですが、将来変更される可能性があります。

タイムアウトが指定されていない場合、またはタイムアウトに 0 が指定されている場合、タイムアウトは設定されません (デフォルトのタイムアウトが 5 分である codeql test run を除きます)。

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

この数のスレッドをクエリの評価に使用します。

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

`--[no-]save-cache`

[詳細設定] 中間結果をディスクキャッシュに積極的に書き込みます。これにはより多くの時間がかかり、使用されるディスク領域も (はるかに) 多くなりますが、同様のクエリの後続の実行が高速化される可能性があります。

`--[no-]expect-discarded-cache`

[詳細設定] クエリの実行後にキャッシュが破棄されるという前提に基づいて、評価する述語とディスクキャッシュに書き込む内容を決定します。

`--[no-]keep-full-cache`

[詳細設定] 評価が完了した後、ディスクキャッシュをクリーンアップしません。これにより、後で codeql dataset cleanup または codeql database cleanup を実行する場合に時間を節約できます。

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

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

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

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

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

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

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

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

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

`--external=<pred>=<file.csv>`

外部述語 <pred> の行を含む CSV ファイル。複数の --external オプションを指定できます。

`--xterm-progress=<mode>`

[詳細設定] xterm 制御シーケンスを使用して、QL 評価中に進行状況の追跡を表示するかどうかを制御します。次のいずれかの値になります。

no: ファンシーな進行状況を表示しません。ダム端末と見なします。

auto (デフォルト値): コマンドが適切なターミナルで実行されているかどうかを自動検出します。__

yes: ターミナルで xterm 制御シーケンスを認識できると見なします。この機能は依然として、ターミナルの "サイズ" を自動検出できるかどうかに依存しており、-q が指定されている場合も無効になります。__

25x80 (またはこれに類する値): yes と同様。ターミナルのサイズも明示的に指定します。

25x80:/dev/pts/17 (またはこれに類する値): stderr とは "異なる" ターミナルにファンシーな進行状況を表示します。__ 主に内部テストに役立ちます。

エバリュエーターに関する構造化ログの出力を制御するためのオプション

`--evaluator-log=<file>`

[詳細設定] 指定されたファイルにエバリュエーターのパフォーマンスに関する構造化ログを出力します。このログファイルの形式は、予告なく変更される場合がありますが、2 つの改行文字 (デフォルト) または --evaluator-log-minify オプションが渡された場合は 1 つの改行文字で区切られた JSON オブジェクトのストリームになります。このファイルのより安定した概要を生成するために codeql generate log-summary <file> を使用し、ファイルを直接解析しないようにしてください。ファイルが既に存在している場合は上書きされます。

database upgrade

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

この記事の内容

構文

説明

[オプション]

主なオプション

`<database>`

`--search-path=<dir>[:<dir>...]`

`--additional-packs=<dir>[:<dir>...]`

`--target-dbscheme=<file>`

`--target-sha=<sha>`

`--[no-]allow-downgrades`

アップグレードクエリの評価を制御するためのオプション

`--[no-]tuple-counting`

`--timeout=<seconds>`

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

`--[no-]save-cache`

`--[no-]expect-discarded-cache`

`--[no-]keep-full-cache`

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

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

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

`--external=<pred>=<file.csv>`

`--xterm-progress=<mode>`

エバリュエーターに関する構造化ログの出力を制御するためのオプション

`--evaluator-log=<file>`

`--evaluator-log-minify`

アップグレードプロセスの RAM 使用量を制御するためのオプション

`-M, --ram=<MB>`

共通オプション

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`