CodeQLCreateDatabaseToolSettings Class

Summary

Tool for creating CodeQL databases
Assembly
Cake.CodeQL.Cli.dll
Namespace
Cake.CodeQL.Cli.Database
Base Types
graph BT Type-->Base0["CodeQLToolSettings"] click Base0 "/api/Cake.CodeQL.Cli/CodeQLToolSettings" Base0-->Base1["ToolSettings"] Type["CodeQLCreateDatabaseToolSettings"] class Type type-node

Syntax

public class CodeQLCreateDatabaseToolSettings : CodeQLToolSettings

Constructors

Name Summary
CodeQLCreateDatabaseToolSettings() Initializes a new instance of the CodeQLCreateDatabaseToolSettings

Properties

Name Value Summary
BuildCommand string
Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from --source-root. Not needed for Python and JavaScript/TypeScript analysis.
CodeScanningConfigFile FilePath
Advanced. Optional (Advanced). Use if you have a configuration file that specifies how to create the CodeQL databases and what queries to run in later steps.
Command string
Gets the command which should be run.
Inherited from CodeQLToolSettings
DatabaseDir DirectoryPath
Specify the location of a directory to create for the CodeQL database. The command will fail if you try to overwrite an existing directory. If you also specify --db-cluster, this is the parent directory and a subdirectory is created for each language analyzed.
DbCluster bool
Optional. Use in multi-language codebases to generate one database for each language specified.
Languages IList<CodeLanguage>
One or more to create CodeQL Database for. Specify the identifier for the language to create a database for, one of: cpp`, `csharp`, `go`, `java`, `javascript`, `python`, and `ruby (use javascript to analyze TypeScript code). When used with --db-cluster, the option accepts a comma-separated list, or can be specified more than once.
NoRunUnnecessaryBuilds bool
Recommended. Use to suppress the build command for languages where the CodeQL CLI does not need to monitor the build (for example, Python and JavaScript/TypeScript).
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
SourceRootDir DirectoryPath
Optional. Use if you run the CLI outside the checkout root of the repository. By default, the database create command assumes that the current directory is the root directory for the source files, use this option to specify a different location.

Methods

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

Extension Methods

Name Value Summary
Dump<CodeQLCreateDatabaseToolSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CodeQLCreateDatabaseToolSettings>(CodeQLCreateDatabaseToolSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CodeQLCreateDatabaseToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CodeQLCreateDatabaseToolSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CodeQLCreateDatabaseToolSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CodeQLCreateDatabaseToolSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin