Note
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 bqrs info <options>... -- <file>
codeql bqrs info <options>... -- <file>
Descripción
Muestra los metadatos de un archivo BQRS.
Este comando muestra información general de los datos contenidos en el archivo BQRS binario compacto que es el resultado de ejecutar una consulta. Muestra los nombres y tamaños de cada conjunto de resultados (tabla) en el archivo BQRS y los tipos de columna de cada uno.
También puede calcular previamente los desplazamientos para usar las opciones de paginación de codeql bqrs decode. Esto es principalmente útil para los complementos IDE.
Opciones
Opciones principales
<file>
[Obligatorio] Archivo BQRS sobre el que se mostrará información.
--format=<fmt>
Selecciona el formato de salida, ya sea text (predeterminado) o json.
Compatibilidad con la paginación en codeql bqrs decode
--paginate-rows=<num>
[Avanzado] Cuando se proporciona junto con --format=json, calcula una tabla de desplazamientos de bytes que más adelante se puede proporcionar a la opción --start-at de codeql bqrs decode, para empezar a transmitir los resultados en las posiciones 0, <num> , 2* <num> , etc.
--paginate-result-set=<name>
[Avanzado] Solo procesa --paginate-rows para los conjuntos de resultados con este nombre. (Si el nombre no coincide con ningún conjunto de resultados, --paginate-rows no es una operación).
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.