{"meta":{"title":"database interpret-results","intro":"[Plumbing] Interpret computed query results into meaningful formats\nsuch as SARIF or CSV.","product":"Security and code quality","breadcrumbs":[{"href":"/en/code-security","title":"Security and code quality"},{"href":"/en/code-security/reference","title":"Reference"},{"href":"/en/code-security/reference/code-scanning","title":"Code scanning"},{"href":"/en/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI manual"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results","title":"database interpret-results"}],"documentType":"article"},"body":"# database interpret-results\n\n\\[Plumbing] Interpret computed query results into meaningful formats\nsuch as SARIF or CSV.\n\n> \\[!NOTE]\n> This content describes the most recent release of the CodeQL CLI. For more information about this release, see .\n>\n> To see details of the options available for this command in an earlier release, run the command with the `--help` option in your terminal.\n\n## Synopsis\n\n```shell copy\ncodeql database interpret-results --format= --output= [--threads=] ... -- ...\n```\n\n## Description\n\n\\[Plumbing] Interpret computed query results into meaningful formats\nsuch as SARIF or CSV.\n\nThe results should have been computed and stored in a CodeQL database\ndirectory using [codeql database run-queries](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries). (Usually you'd want to do these steps together, by using [codeql database analyze](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze)).\n\n## Options\n\n### Primary Options\n\n#### ``\n\n\\[Mandatory] Path to the CodeQL database that has been queried.\n\n#### `...`\n\nRepeat the specification of which queries were executed here.\n\nIf omitted, the CLI will determine a suitable set of queries using the\nsame logic as [codeql database run-queries](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries).\n\n(In a future version it ought to be possible to omit this and instead\ninterpret all results that are found in the database. That glorious\nfuture is not yet. Sorry.)\n\n#### `--format=`\n\n\\[Mandatory] The format in which to write the results. One of:\n\n`csv`: Formatted comma-separated values, including columns with both\nrule and alert metadata.\n\n`sarif-latest`: Static Analysis Results Interchange Format (SARIF), a\nJSON-based format for describing static analysis results. This format\noption uses the most recent supported version (v2.1.0). This option is\nnot suitable for use in automation as it will produce different versions\nof SARIF between different CodeQL versions.\n\n`sarifv2.1.0`: SARIF v2.1.0.\n\n`graphtext`: A textual format representing a graph. Only compatible with\nqueries with @kind graph.\n\n`dgml`: Directed Graph Markup Language, an XML-based format for\ndescribing graphs. Only compatible with queries with @kind graph.\n\n`dot`: Graphviz DOT language, a text-based format for describing graphs.\nOnly compatible with queries with @kind graph.\n\n#### `-o, --output=`\n\n\\[Mandatory] The output path to write results to. For graph formats\nthis should be a directory, and the result (or results if this command\nsupports interpreting more than one query) will be written within that\ndirectory.\n\n#### `--max-paths=`\n\nThe maximum number of paths to produce for each alert with paths.\n(Default: 4)\n\n#### `--[no-]sarif-add-file-contents`\n\n\\[SARIF formats only] Include the full file contents for all files\nreferenced in at least one result.\n\n#### `--[no-]sarif-add-snippets`\n\n\\[SARIF formats only] Include code snippets for each location mentioned\nin the results, with two lines of context before and after the reported\nlocation.\n\n#### `--[no-]sarif-add-query-help`\n\n\\[SARIF formats only] \\[Deprecated] Include Markdown query help for\nall queries. It loads query help for /path/to/query.ql from the\n/path/to/query.md file. If this flag is not supplied the default\nbehavior is to include help only for custom queries i.e. those in query\npacks which are not of the form \\`codeql/\\`\n\n\\[SARIF formats only] Specify whether to include query help in the\nSARIF output. One of:\n\n`always`: Include query help for all queries.\n\n`custom_queries_only` *(default)*: Include query help only for custom\nqueries i.e. those in query packs which are not of the form\n\\`codeql/\\.tool.extensions` property. This\noption has no effect when passed to [codeql bqrs interpret](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret).\n\n#### `--[no-]sarif-multicause-markdown`\n\n\\[SARIF formats only] For alerts that have multiple causes, include\nthem as a Markdown-formatted itemized list in the output in addition to\nas a plain string.\n\n#### `--no-sarif-minify`\n\n\\[SARIF formats only] Produce pretty-printed SARIF output. By default,\nSARIF output is minified to reduce the size of the output file.\n\n#### `--sarif-run-property=`\n\n\\[SARIF formats only] A key value pair to add to the generated SARIF\n'run' property bag. Can be repeated.\n\n#### `--no-group-results`\n\n\\[SARIF formats only] Produce one result per message, rather than one\nresult per unique location.\n\n#### `--csv-location-format=`\n\nThe format in which to produce locations in CSV output. One of: uri,\nline-column, offset-length. (Default: line-column)\n\n#### `--dot-location-url-format=`\n\nA format string defining the format in which to produce file location\nURLs in DOT output. The following place holders can be used {path}\n{start:line} {start:column} {end:line} {end:column}, {offset}, {length}\n\n#### `--[no-]sublanguage-file-coverage`\n\n\\[GitHub.com and GitHub Enterprise Server v3.12.0+ only] Use\nsub-language file coverage information. This calculates, displays, and\nexports separate file coverage information for languages which share a\nCodeQL extractor like C and C++, Java and Kotlin, and JavaScript and\nTypeScript.\n\nAvailable since `v2.15.2`.\n\n#### `--sarif-category=`\n\n\\[SARIF formats only] \\[Recommended] Specify a category for this\nanalysis to include in the SARIF output. A category can be used to\ndistinguish multiple analyses performed on the same commit and\nrepository, but on different languages or different parts of the code.\n\nIf you analyze the same version of a code base in several different ways\n(e.g., for different languages) and upload the results to GitHub for\npresentation in Code Scanning, this value should differ between each of\nthe analyses, which tells Code Scanning that the analyses *supplement*\nrather than *supersede* each other. (The values should be consistent\nbetween runs of the same analysis for *different* versions of the code\nbase.)\n\nThis value will appear (with a trailing slash appended if not already\npresent) as the `.automationDetails.id` property.\n\n#### `-j, --threads=`\n\nThe number of threads used for computing paths.\n\nDefaults to 1. You can pass 0 to use one thread per core on the machine,\nor -*N* to leave *N* cores unused (except still use at least one\nthread).\n\n#### `--no-database-extension-packs`\n\n\\[Advanced] Omit extension packs stored in the database during database\ncreation, either from a Code Scanning configuration file or from\nextension files stored in the 'extensions' directory of the analyzed\ncodebase.\n\n#### `--[no-]print-diagnostics-summary`\n\nPrint a summary of the analyzed diagnostics to standard output.\n\n#### `--[no-]print-metrics-summary`\n\nPrint a summary of the analyzed metrics to standard output.\n\n#### `--[no-]print-baseline-loc`\n\nPrint the baseline lines of code counted to standard output.\n\n### Options for configuring the CodeQL package manager\n\n#### `--registries-auth-stdin`\n\nAuthenticate to GitHub Enterprise Server Container registries by passing\na comma-separated list of \\=\\ pairs.\n\nFor example, you can pass\n`https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\nto authenticate to two GitHub Enterprise Server instances.\n\nThis overrides the CODEQL\\_REGISTRIES\\_AUTH and GITHUB\\_TOKEN environment\nvariables. If you only need to authenticate to the github.com Container\nregistry, you can instead authenticate using the simpler\n`--github-auth-stdin` option.\n\n#### `--github-auth-stdin`\n\nAuthenticate to the github.com Container registry by passing a\ngithub.com GitHub Apps token or personal access token via standard\ninput.\n\nTo authenticate to GitHub Enterprise Server Container registries, pass\n`--registries-auth-stdin` or use the CODEQL\\_REGISTRIES\\_AUTH environment\nvariable.\n\nThis overrides the GITHUB\\_TOKEN environment variable.\n\n### Options to specify which extensions to use when interpreting the results\n\n#### `--model-packs=<`>...\n\nA list of CodeQL pack names, each with an optional version range, to be\nused as model packs to customize the queries that are about to be\nevaluated.\n\n### Options for finding QL packs (which may be necessary to interpret query suites)\n\n#### `--search-path=[:...]`\n\nA list of directories under which QL packs may be found. Each directory\ncan either be a QL pack (or bundle of packs containing a\n`.codeqlmanifest.json` file at the root) or the immediate parent of one\nor more such directories.\n\nIf the path contains more than one directory, their order defines\nprecedence between them: when a pack name that must be resolved is\nmatched in more than one of the directory trees, the one given first\nwins.\n\nPointing this at a checkout of the open-source CodeQL repository ought\nto work when querying one of the languages that live there.\n\nIf you have checked out the CodeQL repository as a sibling of the\nunpacked CodeQL toolchain, you don't need to give this option; such\nsibling directories will always be searched for QL packs that cannot be\nfound otherwise. (If this default does not work, it is strongly\nrecommended to set up `--search-path` once and for all in a per-user\nconfiguration file).\n\n(Note: On Windows the path separator is `;`).\n\n#### `--additional-packs=[:...]`\n\nIf this list of directories is given, they will be searched for packs\nbefore the ones in `--search-path`. The order between these doesn't\nmatter; it is an error if a pack name is found in two different places\nthrough this list.\n\nThis is useful if you're temporarily developing a new version of a pack\nthat also appears in the default path. On the other hand, it is *not\nrecommended* to override this option in a config file; some internal\nactions will add this option on the fly, overriding any configured\nvalue.\n\n(Note: On Windows the path separator is `;`).\n\n### Common options\n\n#### `-h, --help`\n\nShow this help text.\n\n#### `-J=`\n\n\\[Advanced] Give option to the JVM running the command.\n\n(Beware that options containing spaces will not be handled correctly.)\n\n#### `-v, --verbose`\n\nIncrementally increase the number of progress messages printed.\n\n#### `-q, --quiet`\n\nIncrementally decrease the number of progress messages printed.\n\n#### `--verbosity=`\n\n\\[Advanced] Explicitly set the verbosity level to one of errors,\nwarnings, progress, progress+, progress++, progress+++. Overrides `-v`\nand `-q`.\n\n#### `--logdir=`\n\n\\[Advanced] Write detailed logs to one or more files in the given\ndirectory, with generated names that include timestamps and the name of\nthe running subcommand.\n\n(To write a log file with a name you have full control over, instead\ngive `--log-to-stderr` and redirect stderr as desired.)\n\n#### `--common-caches=`\n\n\\[Advanced] Controls the location of cached data on disk that will\npersist between several runs of the CLI, such as downloaded QL packs and\ncompiled query plans. If not set explicitly, this defaults to a\ndirectory named `.codeql` in the user's home directory; it will be\ncreated if it doesn't already exist.\n\nAvailable since `v2.15.2`."}