This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.CodeQL.Cli.

Summary

Tool for creating CodeQL databases

Assembly

Cake.CodeQL.Cli.dll

Namespace

Cake.CodeQL.Cli.Database

Base Types

ToolSettings
CodeQLToolSettings

graph BT Type-->Base0["CodeQLToolSettings"] click Base0 "/api/Cake.CodeQL.Cli/CodeQLToolSettings" Base0-->Base1["ToolSettings"] Type["CodeQLAnalyzeDatabaseToolSettings"] class Type type-node

Syntax

public class CodeQLAnalyzeDatabaseToolSettings : CodeQLToolSettings

Constructors

Name	Summary
CodeQLAnalyzeDatabaseToolSettings()	Initializes a new instance of the `CodeQLAnalyzeDatabaseToolSettings`

Properties

Name	Value	Summary
Command	string	Gets the command which should be run. Inherited from CodeQLToolSettings
DatabaseDir	DirectoryPath	Specifies the path for the directory that contains the CodeQL database to analyze.
Download	IList<string>	Use if some of your CodeQL query packs are not yet on disk and need to be downloaded before running queries.
Format	string	Specify the format for the results file generated by the command. For upload to GitHub this should be: sarif-latest.
OutputFile	FilePath	Specify where to save the SARIF results file.
QueryPacks	IList<string>	Specify CodeQL packs or queries to run. To run the standard queries used for code scanning, omit this parameter. To see the other query suites included in the CodeQL CLI bundle, look in /<extraction-root>/qlpacks/codeql/<language>-queries/codeql-suites. For information about creating your own query suite, see Creating CodeQL query suites in the documentation for the CodeQL CLI.
RedirectStandardError	bool	Gets or sets the process option to redirect standard error Inherited from CodeQLToolSettings
RedirectStandardOutput	bool	Gets or sets the process option to redirect standard output Inherited from CodeQLToolSettings
SarifAddQueryHelp	string	Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert.
SarifCategory	string	Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
Threads	Nullable<int>	Use if you want to use more than one thread to run queries. The default value is 1. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify 0.
Verbose	bool	Optional. Use to get more detailed information about the analysis process and diagnostic data from the database creation process

Methods

Name	Value	Summary
EvaluateCore(ProcessArgumentBuilder)	void	Evaluates the settings and writes them to args.

Extension Methods