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 decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
Descripción
Convierte los datos de resultados de BQRS en otros formularios.
La salida descodificada se escribirá en la salida estándar, a menos que se especifique la opción --output.
Opciones
Opciones principales
<file>
[Obligatorio] Archivo BQRS para descodificar.
-o, --output=<file>
El archivo donde se escribe la salida deseada.
-r, --result-set=<name>
Selecciona un conjunto de resultados determinado del archivo BQRS que se va a descodificar. Los conjuntos de resultados disponibles se pueden enumerar mediante codeql bqrs info.
Si no se selecciona ningún conjunto de resultados, se descodificarán todos los conjuntos de resultados, siempre que el formato de salida seleccionado y las opciones de procesamiento admitan eso. De lo contrario, se produce un error.
-k, --sort-key=<col>[,<col>...]
Ordena el conjunto de resultados seleccionado por las columnas indicadas.
--sort-direction=<direction>[,<direction>...]
Ordena el conjunto de resultados seleccionado mediante las direcciones de ordenación indicadas.
Si no se especifican las direcciones de ordenación, se usará el orden ascendente para todas las columnas.
Opciones de formato de salida
--format=<fmt>
Selecciona el formato de salida. Entre las opciones se incluyen:
text (valor predeterminado) : una tabla de texto sin formato legible.
csv: valores separados por comas.
json: JSON de streaming.
bqrs: BQRS. Debe usarse con --output. Lo más útil junto con --sort-key.
--no-titles
Omite los títulos de columna para los formatos text y csv.
--entities=<fmt>[,<fmt>...]
[Avanzado] Controla cómo se muestran las columnas de resultado del tipo de entidad. Lista separada por comas de las siguientes opciones:
url: una dirección URL que hace referencia a una ubicación de origen, si la consulta se compiló para generar estas direcciones URL para los tipos de entidad.
string: una cadena calculada por el método toString() en QL, si la consulta se compiló para generar estas cadenas para la columna.
id: el identificador interno de la entidad, que puede no ser informativo.
all: muestra columnas con toda la información que proporciona el archivo BQRS.
Se muestran todas las opciones seleccionadas, si es posible.
Opciones de paginación (para su uso por los front-ends interactivos)
--rows=<num>
[Avanzado] Genera estas muchas filas del conjunto de resultados seleccionado, comenzando en la parte superior o en la ubicación dada por --start-at.
--start-at=<offset>
[Avanzado] Empieza a imprimir la fila definida en un desplazamiento de bytes determinado en el archivo BQRS. El desplazamiento debe obtenerse de codeql bqrs info o del puntero "next" que se encuentra en la salida JSON de una invocación anterior con --rows establecido. Es probable que otros desplazamientos produzcan errores explícitos o de salida sin sentido.
Siempre se debe usar junto con --rows y no es compatible con --sort-key.
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.