CodeQL データベースの管理

拡張機能を使用して、CodeQL データベースを操作できます。

この記事の内容

CodeQL データベースについて

プロジェクトを分析するには、そのプロジェクトの CodeQL データベースを選択する必要があります。 データベースは、ローカルで (ZIP アーカイブまたはアーカイブされていないフォルダーから)、パブリック URL から、または GitHub のプロジェクトの URL から選択できます。 または、CodeQL CLI を使用してデータベースを作成できます。「CodeQL 分析のためのコードの準備」を参照してください。

GitHub からデータベースをダウンロードする

GitHub.com には、分析のテストに使用できる 200,000 を超えるオープンソース リポジトリの CodeQL データベースが格納されます。 また、設定を編集してシステムの URL を定義することで、データ所在地付き GitHub Enterprise Cloud でホストされているリポジトリのデータベースにアクセスすることもできます。「拡張機能で使用される GitHub URL の変更」を参照してください。

リポジトリにダウンロード可能な CodeQL データベースがあるかどうかを確認でき、ある場合は REST API を使用してダウンロードできます。 詳しくは、GitHub REST API ドキュメントの「リポジトリの CodeQL データベースを一覧表示する」と「リポジトリの CodeQL データベースを取得する」を参照してください。

分析するデータベースの選択

  1. [データベース] ビューのタイトル バーにカーソルを合わせ、適切なアイコンを選択してデータベースを選択します。 ローカル データベース (ZIP アーカイブまたはアーカイブされていないフォルダーからの) は、パブリック URL から、または GitHub のプロジェクトの URL から選択できます。

  2. データベースを選択すると、[データベース] ビューに表示されます。 データベースを操作するためのメニュー オプションを表示するには、一覧のエントリを右クリックします。 複数のデータベースを一度に選択することができます。

Note

テスト データベースを分析することもできます。 テスト データベース (拡張子が .testproj のフォルダー) は、CodeQL CLI を使用してカスタム クエリに対して回帰テストを実行すると生成されます。 クエリが回帰テストに失敗した場合は、テスト データベースを Visual Studio Code にインポートしてエラーをデバッグできます。 クエリ テストの実行について詳しくは、「カスタム クエリのテスト」を参照してください。

言語によるデータベースとクエリのフィルター処理

必要に応じて、特定の言語を含むデータベースとその言語用に記述されたクエリを表示するには、言語セレクターを使用して言語フィルターを適用できます。

  1. 利用可能な言語フィルターを表示するには、サイドバーで [言語] ビューを開きます。

  2. 適用する言語フィルターにカーソルを合わせ、[選択] をクリックします。

次のステップ

拡張機能を使用して、CodeQL データベースに対してクエリを実行してプロジェクトを分析する方法については、「CodeQL クエリの実行」を参照してください。