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 dataset check <options>... -- <dataset>
codeql dataset check <options>... -- <dataset>
Description
[Plomberie] Vérifie la cohérence interne d’un jeu de données particulier.
Cette commande est généralement utile pour les développeurs d’extracteurs CodeQL, car elle valide les données produites par l’extracteur. Elle peut également être utile si les requêtes sur une base de données donnent des résultats incohérents, pour exclure les problèmes dans les données sous-jacentes comme étant la cause.
Options
Options principales
<dataset>
[Obligatoire] Chemin du jeu de données QL brut à vérifier.
--failing-exitcode=<code>
[Avancé] Définit le code de sortie à produire en cas d’échec. Généralement 1, mais les outils qui analysent la sortie peuvent trouver utile de la définir sur 0.
--format=<fmt>
Sélectionne le format de sortie. Choix possibles :
text (par défaut) : Rendu textuel lisible par les êtres humains.
json : Tableau d’objets JSON diffusé en streaming.
jsonz : Flux d’objets JSON se terminant par zéro.
--[no-]precise-locations
[Avancé] Fait un effort supplémentaire pour calculer les emplacements précis pour les incohérences. Cela prend plus de temps, mais peut faciliter le débogage du comportement de l’extracteur.
--max-resolve-depth=<n>
[Avancé] Degré maximal auquel les ID doivent être résolus pour expliquer les incohérences. (Valeur par défaut : 3)
--max-errors-per-checker=<n>
Nombre maximal d’erreurs d’incohérence de chaque type devant être signalées explicitement. (Par défaut : 5)
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.