Skip to main content

dataset check

[Plomberie] VĂ©rifie la cohĂ©rence interne d’un jeu de donnĂ©es particulier.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de rĂ©fĂ©rentiels suivants :

Remarque

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

Shell
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.