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 database bundle --output=<output> <options>... -- <database>
codeql database bundle --output=<output> <options>... -- <database>
Descripción
Crea un archivo reasignable de una base de datos CodeQL.
Comando que comprime las partes útiles de la base de datos. Esto solo incluirá los componentes obligatorios, a menos que el usuario solicite específicamente que se incluyan resultados, registros, TRAP o similares.
Opciones
Opciones principales
<database>
[Obligatorio] Ruta de acceso a la base de datos CodeQL que se va a agrupar.
-o, --output=<output>
[Obligatorio] El archivo de salida, normalmente con la extensión ".zip".
--[no-]include-diagnostics
Incluye diagnósticos en la agrupación.
Disponible desde la versión v2.16.0.
--[no-]include-results
Incluye los resultados de las consultas preprocesadas en la agrupación.
--[no-]include-logs
Incluye el directorio de registros en la agrupación.
Disponible desde la versión v2.17.6.
--[no-]include-temp
Incluye el directorio "temp", donde se encuentran los paquetes, las consultas y los conjuntos generados.
Disponible desde la versión v2.13.3.
--[no-]include-uncompressed-source
Incluye una versión sin comprimir del directorio de archivo de origen. Esto es necesario para complementos de CodeQL heredados (como CodeQL para Eclipse).
--name=<name>
Nombre del directorio de nivel superior de la agrupación. Si no se especifica, el valor predeterminado es el nombre del directorio de la base de datos.
Opciones de limpieza de conjuntos de datos de bajo nivel
--max-disk-cache=<MB>
Establece la cantidad máxima de espacio que puede usar la caché del disco para los resultados intermedios de la consulta.
Si este tamaño no está configurado explícitamente, el evaluador intentará usar una cantidad "razonable" de espacio de caché, en función del tamaño del conjunto de datos y de la complejidad de las consultas. Establecer explícitamente un límite mayor que este uso predeterminado permitirá el almacenamiento en caché adicional que puede acelerar las consultas posteriores.
--min-disk-free=<MB>
[Avanzado] Establece la cantidad de espacio libre de destino en el sistema de archivos.
Si no se proporciona --max-disk-cache, el evaluador intentará reducir el uso de la caché del disco si el espacio libre en el sistema de archivos cae por debajo de este valor.
--min-disk-free-pct=<pct>
[Avanzado] Establece la fracción de destino del espacio libre en el sistema de archivos.
Si no se proporciona --max-disk-cache, el evaluador intentará reducir el uso de la caché del disco si el espacio libre en el sistema de archivos cae por debajo de este porcentaje.
--cache-cleanup=<mode>
Selecciona cómo recortar la caché de forma agresiva. Entre las opciones se incluyen:
clear: quita toda la caché y recorta hasta el estado de un conjunto de datos recién extraído.
trim (valor predeterminado) : recorta todo excepto los predicados "almacenados en caché" explícitamente.
fit: simplemente asegúrese de que se observan los límites de tamaño definidos para la caché de disco y que se eliminan tantos intermedios como sea necesario.
--cleanup-upgrade-backups
Elimina los directorios de copia de seguridad resultantes de las actualizaciones de la base de datos.
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.