{"meta":{"title":"test extract","intro":"[Plumbing] Build a dataset for a test directory.","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/test-extract","title":"test extract"}],"documentType":"article"},"body":"# test extract\n\n\\[Plumbing] Build a dataset for a test directory.\n\n> \\[!NOTE]\n> This content describes the most recent release of the CodeQL CLI. For more information about this release, see <https://github.com/github/codeql-cli-binaries/releases>.\n>\n> To see details of the options available for this command in an earlier release, run the command with the <span style=\"white-space: nowrap;\">`--help`</span> option in your terminal.\n\n## Synopsis\n\n```shell copy\ncodeql test extract [--print-database] [--source-root=<dir>] <options>... -- <testDirectory>\n```\n\n## Description\n\n\\[Plumbing] Build a dataset for a test directory.\n\nBuild a database for a specified test directory, without actually\nrunning any test queries. Outputs the path to the raw QL dataset to\nexecute test queries against.\n\n## Options\n\n### Primary Options\n\n#### `<testDirectory>`\n\n\\[Mandatory] The path to the test directory.\n\n#### `--database=<dir>`\n\nOverride the location of the database being created. By default it will\nbe a subdirectory whose name is derived from the name of the test\ndirectory itself with '.testproj' appended.\n\n#### `-D, --print-database`\n\nPrint the path to the database being created, rather than the dataset\ninside it.\n\n#### `-s, --source-root=<dir>`\n\n\\[Advanced] The root source code directory, if different from the test\ndirectory.\n\n#### `--search-path=<dir>[:<dir>...]`\n\nA list of directories under which extractor packs may be found. The\ndirectories can either be the extractor packs themselves or directories\nthat contain extractors as immediate subdirectories.\n\nIf the path contains multiple directory trees, their order defines\nprecedence between them: if the target language is matched in more than\none of the directory trees, the one given first wins.\n\nThe extractors bundled with the CodeQL toolchain itself will always be\nfound, but if you need to use separately distributed extractors you need\nto give this option (or, better yet, set up `--search-path` in a\nper-user configuration file).\n\n(Note: On Windows the path separator is `;`).\n\n#### `--cleanup`\n\nRemove the test database instead of creating it.\n\n#### `--[no-]show-extractor-output`\n\n\\[Advanced] Show the output from extractor scripts that create test\ndatabases. This can be useful while developing or editing test cases.\nBeware that it can cause duplicated or malformed output if you use this\nwith multiple threads!\n\n#### `--[no-]check-undefined-labels`\n\n\\[Advanced] Report errors for undefined labels.\n\n#### `--[no-]check-unused-labels`\n\n\\[Advanced] Report errors for unused labels.\n\n#### `--[no-]check-repeated-labels`\n\n\\[Advanced] Report errors for repeated labels.\n\n#### `--[no-]check-redefined-labels`\n\n\\[Advanced] Report errors for redefined labels.\n\n#### `--[no-]check-use-before-definition`\n\n\\[Advanced] Report errors for labels used before they're defined.\n\n#### `--[no-]fail-on-trap-errors`\n\n\\[Advanced] Exit non-zero if an error occurs during trap import.\n\n#### `--[no-]include-location-in-star`\n\n\\[Advanced] Construct entity IDs that encode the location in the TRAP\nfile they came from. Can be useful for debugging of TRAP generators, but\ntakes up a lot of space in the dataset.\n\n#### `--[no-]linkage-aware-import`\n\n\\[Advanced] Controls whether [codeql dataset import](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import) is linkage-aware *(default)* or not. On projects where this part of database creation\nconsumes too much memory, disabling this option may help them progress\nat the expense of database completeness.\n\nAvailable since `v2.15.3`.\n\n#### `--format=<fmt>`\n\nSelect output format, either `text` *(default)* or `json`.\n\n### Common options\n\n#### `-h, --help`\n\nShow this help text.\n\n#### `-J=<opt>`\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=<level>`\n\n\\[Advanced] Explicitly set the verbosity level to one of errors,\nwarnings, progress, progress+, progress++, progress+++. Overrides `-v`\nand `-q`.\n\n#### `--logdir=<dir>`\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=<dir>`\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`."}