{"meta":{"title":"database add-diagnostic","intro":"[实验性] 向数据库添加一条诊断信息。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic","title":"database add-diagnostic"}],"documentType":"article"},"body":"# database add-diagnostic\n\n[实验性] 向数据库添加一条诊断信息。\n\n> [!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style=\"white-space: nowrap;\">`--help`</span> 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>\n```\n\n## Description\n\n              \\[实验性] 向数据库添加一条诊断信息。\n\n自 `v2.12.6` 起可用。\n\n## 选项\n\n### 主要选项\n\n#### `<database>`\n\n              \\[必选] 要捆绑的 CodeQL 数据库的路径。\n\n#### `--markdown-message=<markdownMessage>`\n\n诊断消息，采用 GitHub 风格的 Markdown 格式。\n\n#### `--plaintext-message=<plaintextMessage>`\n\n诊断消息，采用纯文本形式。 仅当使用 --markdown-message 填充 Markdown 消息不切实际时，才应使用此选项。\n\n#### `--severity=<severity>`\n\n诊断的严重性。 可以是“错误”、“警告”或“通知”。\n\n#### `--help-link=<helpLinks>`\n\n与诊断相关的帮助链接。\n\n#### `--attributes-json=<attributesJson>`\n\n与诊断相关的结构化元数据。\n\n### 指示可以显示诊断消息的位置的选项\n\n#### `--ready-for-status-page`\n\n指示诊断适合显示在状态页上。\n\n#### `--ready-for-cli-summary-table`\n\n指示诊断适合显示在由 `database analyze` 之类的命令打印的诊断摘要表中。\n\n### 描述诊断源的选项\n\n#### `--source-id=<id>`\n\n              \\[必选] 此诊断信息的来源标识符。\n\n#### `--source-name=<name>`\n\n              \\[必选] 此诊断信息来源的人类可读描述。\n\n#### `--extractor-name=<extractorName>`\n\nCodeQL 提取程序的名称（如果此诊断由 CodeQL 提取程序生成）。\n\n### 描述诊断位置的选项\n\n#### `--file-path=<file>`\n\n诊断应用到的文件相对于源根目录的路径。\n\n#### `--start-line=<startLine>`\n\n表示诊断起始位置的从 1 开始的行号（非独占）。\n\n#### `--start-column=<startColumn>`\n\n表示诊断起始位置的从 1 开始的列号（非独占）。\n\n#### `--end-line=<endLine>`\n\n表示诊断结束位置的从 1 开始的行号（非独占）。\n\n#### `--end-column=<endColumn>`\n\n表示诊断结束位置的从 1 开始的列号（非独占）。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=<opt>`\n\n              \\[高级] 向运行命令的 JVM 提供选项。\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=<level>`\n\n              \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n\n#### `--logdir=<dir>`\n\n              \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=<dir>`\n\n              \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n\n自 `v2.15.2` 起可用。"}