En este contenido se describe la versión más reciente de CodeQL CLI. Para obtener más información sobre esta versión, consulta https://github.com/github/codeql-cli-binaries/releases.
Para ver detalles de las opciones disponibles para este comando en una versión anterior, ejecuta el comando con la opción --help en el terminal.
Sinopsis
codeql dataset check <options>... -- <dataset>
codeql dataset check <options>... -- <dataset>
Descripción
[Asociación] Comprueba si existe coherencia interna en un conjunto de datos determinado.
Este comando suele ser más útil para los desarrolladores de extractores de CodeQL, ya que valida los datos generados por el extractor. También puede ser útil si las consultas de una base de datos generan resultados incoherentes, para descartar los problemas en los datos subyacentes como causa.
Opciones
Opciones principales
<dataset>
[Obligatorio] Ruta de acceso al conjunto de datos de QL sin procesar que se va a comprobar.
--failing-exitcode=<code>
[Avanzado] Establece el código de salida para generar si se encuentran errores. Normalmente es 1, pero las herramientas que analizan la salida pueden resultar útiles para establecerlo en 0.
--format=<fmt>
Selecciona el formato de salida. Opciones posibles:
text (predeterminado) : representación textual en lenguaje natural.
json: matriz JSON de objetos secuenciada.
jsonz: secuencia de objetos JSON terminados en cero.
--[no-]precise-locations
[Avanzado] Invierte un esfuerzo adicional para calcular las ubicaciones precisas de las incoherencias. Esta operación tardará más, pero puede facilitar la depuración del comportamiento del extractor.
--max-resolve-depth=<n>
[Avanzado] Profundidad máxima a la que deben resolverse los identificadores para explicar las incoherencias. (Valor predeterminado: 3)
--max-errors-per-checker=<n>
Número máximo de errores de incoherencia de cada tipo que deben notificarse de forma explícita. (Valor predeterminado: 5)
Opciones comunes
-h, --help
Muestra este texto de ayuda.
-J=<opt>
[Avanzado] Asigna la opción a la JVM que ejecuta el comando.
(Ten en cuenta que las opciones que contienen espacios no se administrarán correctamente).
-v, --verbose
Aumenta incrementalmente el número de mensajes de progreso impresos.
-q, --quiet
Reduce incrementalmente el número de mensajes de progreso impresos.
--verbosity=<level>
[Avanzado] Establece explícitamente el nivel de detalle en errores, advertencias, progreso, progreso+, progreso++, progreso+++. Invalida -v y -q.
--logdir=<dir>
[Avanzado] Escribe registros detallados en uno o varios archivos del directorio especificado, con nombres generados que incluyen marcas de tiempo y el nombre del subcomando en ejecución.
(Para escribir un archivo de registro con un nombre sobre el que tienes control total, proporciona --log-to-stderr y redirige stderr como quieras).
--common-caches=<dir>
[Avanzado] Controla la ubicación de los datos en caché del disco que se conservarán entre varias ejecuciones de la CLI, como paquetes QL descargados y planes de consulta compilada. Si no se define explícitamente, se toma como predeterminado un directorio denominado .codeql en el directorio principal del usuario, que se creará en caso de que no exista.
Disponible desde la versión v2.15.2.