{"meta":{"title":"database import","intro":"[Advanced] [Plumbing] Import unfinalized database(s) into another\nunfinalized database.","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-import","title":"database import"}],"documentType":"article"},"body":"# database import\n\n\\[Advanced] \\[Plumbing] Import unfinalized database(s) into another\nunfinalized database.\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 import [--dbscheme=] [--threads=] [--ram=] ... -- ...\n```\n\n## Description\n\n\\[Advanced] \\[Plumbing] Import unfinalized database(s) into another\nunfinalized database.\n\nThe result of this command is that the target database (the one in the\n*first* argument) will be augmented with the data from all the other\ndatabases passed. In particular, TRAP files from the other databases\nwill be imported and sources in them will be copied.\n\nNote that this command will probably not have the desired effect in most\ncases. In particular, the resulting database may not correctly track\ndataflow between the partial databases that were combined. It is only\nintended to be used in certain advanced scenarios involving distributed\nbuild systems where special care has been taken in how the build was\nseparated in order to ensure that the resulting final database is\nmeaningful.\n\n## Options\n\n### Primary Options\n\n#### ``\n\n\\[Mandatory] Path to the CodeQL database under construction. This must\nhave been prepared for extraction with [codeql database init](/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init).\n\nIf the `--db-cluster` option is given, this is not a database itself,\nbut a directory that *contains* databases, and all of those databases\nwill be processed together.\n\n#### `...`\n\n\\[Mandatory] Paths to the unfinished database(s) that should imported\ninto the first database.\n\nIf the `--db-cluster` option is given, it is expected that these will be\ndatabase clusters rather than individual CodeQL databases.\n\n#### `--[no-]db-cluster`\n\nIndicates that the directory given on the command line is not a database\nitself, but a directory that *contains* one or more databases under\nconstruction. Those databases will be processed together.\n\n### Options for controlling the TRAP import operation\n\n#### `-S, --dbscheme=`\n\n\\[Advanced] Override the auto-detected dbscheme definition that the\nTRAP files are assumed to adhere to. Normally, this is taken from the\ndatabase's extractor.\n\n#### `-j, --threads=`\n\nUse this many threads for the import operation.\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#### `-M, --ram=`\n\nUse this much memory for the import operation.\n\n### Options for checking imported TRAP\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### 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`."}