{"meta":{"title":"bqrs info","intro":"Display metadata for a BQRS file.","product":"Security and code quality","breadcrumbs":[{"href":"/en/enterprise-server@3.20/code-security","title":"Security and code quality"},{"href":"/en/enterprise-server@3.20/code-security/reference","title":"Reference"},{"href":"/en/enterprise-server@3.20/code-security/reference/code-scanning","title":"Code scanning"},{"href":"/en/enterprise-server@3.20/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/en/enterprise-server@3.20/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI manual"},{"href":"/en/enterprise-server@3.20/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info","title":"bqrs info"}],"documentType":"article"},"body":"# bqrs info\n\nDisplay metadata for a BQRS file.\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 bqrs info <options>... -- <file>\n```\n\n## Description\n\nDisplay metadata for a BQRS file.\n\nThis command displays an overview of the data contained in the compact\nbinary BQRS file that is the result of executing a query. It shows the\nnames and sizes of each result set (table) in the BQRS file, and the\ncolumn types of each result set.\n\nIt can also optionally precompute offsets for using the pagination\noptions of [codeql bqrs decode](/en/enterprise-server@3.20/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode). This is mainly useful for IDE plugins.\n\n## Options\n\n### Primary Options\n\n#### `<file>`\n\n\\[Mandatory] BQRS file to show information about.\n\n#### `--format=<fmt>`\n\nSelect output format, either `text` *(default)* or `json`.\n\n### Supporting pagination in codeql bqrs decode\n\n#### `--paginate-rows=<num>`\n\n\\[Advanced] When given together with `--format=json`, compute a table\nof byte offsets that can later be given to the `--start-at` option of\n[codeql bqrs decode](/en/enterprise-server@3.20/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode), to start streaming results at positions 0, *\\<num>*, 2\\**\\<num>*, and so\nforth.\n\n#### `--paginate-result-set=<name>`\n\n\\[Advanced] Only process `--paginate-rows` for result sets with this\nname. (If the name does not match any result set, `--paginate-rows` is a\nno-op).\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`."}