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 import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
Descripción
[Avanzado] [Asociación] Importa las bases de datos sin finalizar en otra base de datos sin finalizar.
El resultado de este comando es que la base de datos de destino (la que se encuentra en el primer argumento) se incrementará con los datos de todas las demás bases de datos pasadas. En concreto, los archivos TRAP de las demás bases de datos se importarán y se copiarán los orígenes de ellas.
Tenga en cuenta que, en la mayoría de los casos, este comando no tendrá probablemente el efecto deseado. En concreto, es posible que la base de datos resultante no realice un seguimiento correcto del flujo de datos entre las bases de datos parciales combinadas. Solo está pensado para usarse en determinados escenarios avanzados que implican sistemas de compilación distribuidos en los que se ha tomado especial atención en cómo se ha separado la compilación para asegurarse de que la base de datos final resultante sea significativa.
Opciones
Opciones principales
<database>
[Obligatorio] Ruta de acceso a la base de datos CodeQL en construcción. Debe haberse preparado para la extracción con codeql database init.
Si se proporciona la opción --db-cluster
, no es una base de datos propiamente dicha, sino un directorio que contiene bases de datos y todas esas bases de datos se procesarán juntas.
<additionalDbs>...
[Obligatorio] Rutas de acceso a las bases de datos no finalizadas que se deben importar en la primera base de datos.
Si se proporciona la opción --db-cluster
, se espera que sean clústeres de bases de datos en lugar de bases de datos CodeQL individuales.
--[no-]db-cluster
Indica que el directorio especificado en la línea de comandos no es una base de datos propiamente dicha, sino un directorio que contiene una o varias bases de datos en construcción. Esas bases de datos se procesarán juntas.
Opciones para controlar la operación de importación de TRAP
-S, --dbscheme=<file>
[Avanzado] Invalida la definición de dbscheme detectada automáticamente a la que se supone que se adhieren los archivos TRAP. Normalmente, se toma del extractor de la base de datos.
-j, --threads=<num>
Use estos numerosos subprocesos para la operación de importación.
De manera predeterminada, su valor es 1. Puedes pasar 0 para usar un subproceso por núcleo en la máquina o N para dejar N núcleos sin usar (excepto que aún se usa al menos un subproceso).
-M, --ram=<MB>
Usa esta gran cantidad de memoria para la operación de importación.
Opciones para comprobar TRAP importado
--[no-]check-undefined-labels
[Avanzado] Notifica errores de etiquetas no definidas.
--[no-]check-unused-labels
[Avanzado] Notifica errores de etiquetas sin usar.
--[no-]check-repeated-labels
[Avanzado] Notifica errores de etiquetas repetidas.
--[no-]check-redefined-labels
[Avanzado] Notifica errores de etiquetas redefinidas.
--[no-]check-use-before-definition
[Avanzado] Notifica errores de etiquetas usadas antes de definirlas.
--[no-]fail-on-trap-errors
[Avanzado] Sale con un valor distinto de cero si se produce un error durante la importación de capturas.
--[no-]include-location-in-star
[Avanzado] Construye identificadores de entidad que codifican la ubicación en el archivo TRAP del que proceden. Puede ser útil para la depuración de generadores TRAP, pero ocupa mucho espacio en el conjunto de datos.
--[no-]linkage-aware-import
[Avanzado] Controla si codeql dataset import reconoce la vinculación (valor predeterminado) o no. En los proyectos en los que esta parte de la creación de la base de datos consume demasiada memoria, deshabilitar esta opción puede ayudarles a avanzar a costa de la integridad de la base de datos.
Disponible desde la versión v2.15.3
.
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
.