Note
Ce contenu décrit la version la plus récente de CodeQL CLI. Pour plus d’informations sur cette version, consultez https://github.com/github/codeql-cli-binaries/releases.
Pour voir les détails des options disponibles pour cette commande dans une version antérieure, exécutez la commande avec l’option --help dans votre terminal.
Synopsis
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>
Description
Convertit les données de résultat de BQRS en d’autres formes.
La sortie décodée est écrite dans la sortie standard, sauf si l’option --output est spécifiée.
Options
Options principales
<file>
[Obligatoire] Fichier BQRS à décoder.
-o, --output=<file>
Fichier sur lequel écrire la sortie souhaitée.
-r, --result-set=<name>
Sélectionne un jeu de résultats particulier dans le fichier BQRS à décoder. Les jeux de résultats disponibles peuvent être listés par codeql bqrs info.
Si aucun jeu de résultats n’est sélectionné, tous les jeux de résultats sont décodés, à condition que le format de sortie et les options de traitement sélectionnés prennent en charge cela. Sinon, une erreur se produit.
-k, --sort-key=<col>[,<col>...]
Trie le jeu de résultats sélectionné en fonction des colonnes indiquées.
--sort-direction=<direction>[,<direction>...]
Trie le jeu de résultats sélectionné en utilisant les consignes de tri indiquées.
Si les consignes de tri ne sont pas spécifiées, l’ordre croissant est utilisé pour toutes les colonnes.
Options de format de sortie
--format=<fmt>
Sélectionne le format de sortie. Les options sont les suivantes :
text (par défaut) : Tableau de texte brut lisible par les êtres humains.
csv : Valeurs séparées par des virgules.
json : JSON en streaming.
bqrs : BQRS. Doit être utilisé avec --output. Plus utile avec --sort-key.
--no-titles
Omet les titres de colonne pour les formats text et csv
--entities=<fmt>[,<fmt>...]
[Avancé] Contrôle l’affichage des colonnes de résultats de type d’entité. Liste séparée par des virgules des éléments suivants :
url : URL faisant référence à un emplacement source, si la requête a été compilée pour produire ces URL pour les types d’entité.
string : Chaîne calculée par la méthode toString() dans QL, si la requête a été compilée pour produire ces chaînes pour la colonne.
id : ID interne de l’entité, qui peut ne pas apporter d’information.
all : Affiche les colonnes avec toutes les informations que fournit le fichier BQRS.
Toutes les options sélectionnées sont montrées, si possible.
Options pour la pagination (à utiliser par les front-ends interactifs)
--rows=<num>
[Avancé] Extrait le nombre de lignes spécifié à partir du jeu de résultats sélectionné, en commençant en haut ou à l’emplacement fourni par --start-at.
--start-at=<offset>
[Avancé] Commence à afficher la ligne définie à un décalage d’octet particulier dans le fichier BQRS. Le décalage doit être obtenu de codeql bqrs info ou du pointeur « suivant » trouvé dans la sortie JSON d’un appel précédent avec --rows défini. Les autres décalages sont susceptibles de produire une sortie inepte et/ou des erreurs explicites.
Doit toujours être utilisé avec --rows, et est incompatible avec --sort-key.
Options courantes
-h, --help
Affiche ce texte d’aide.
-J=<opt>
[Avancé] Donne une option à l’environnement JVM exécutant la commande.
(Attention, les options contenant des espaces ne sont pas gérées correctement.)
-v, --verbose
Augmente de façon incrémentielle le nombre de messages de progression affichés.
-q, --quiet
Diminue de façon incrémentielle le nombre de messages de progression affichés.
--verbosity=<level>
[Avancé] Définit explicitement le niveau de détail sur errors, warnings, progress, progress+, progress++ ou progress+++. Remplace -v et -q.
--logdir=<dir>
[Avancé] Écrit des journaux détaillés dans un ou plusieurs fichiers du répertoire donné, avec des noms générés qui incluent des horodatages et le nom de la sous-commande en cours d’exécution.
(Pour écrire un fichier journal avec un nom sur lequel vous avez un contrôle total, donnez plutôt --log-to-stderr et redirigez stderr comme vous le souhaitez.)
--common-caches=<dir>
[Avancé] Contrôle l’emplacement des données en cache sur le disque qui persisteront entre plusieurs exécutions de l’interface CLI, telles que les packs QL téléchargés et les plans de requête compilés. S’il n’est pas défini explicitement, il s’agit par défaut d’un répertoire nommé .codeql dans le répertoire de base de l’utilisateur. S’il n’existe pas déjà, il est créé.
Disponible depuis v2.15.2.