Skip to main content

Cette version de GitHub Enterprise Server ne sera plus disponible le 2024-06-29. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

bqrs info

Affiche les métadonnées d’un fichier BQRS.

Qui peut utiliser cette fonctionnalité ?

GitHub CodeQL est concédé sous licence par utilisateur lors de l’installation. Vous pouvez utiliser CodeQL uniquement pour certaines tâches soumises aux restrictions de licence. Pour plus d’informations, consultez « À propos de CodeQL CLI ».

Si vous disposez d’une licence GitHub Advanced Security, vous pouvez utiliser CodeQL pour l’analyse automatisée, l’intégration continue et la livraison continue. Pour plus d’informations, consultez « À propos de GitHub Advanced Security ».

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 bqrs info <options>... -- <file>

Description

Affiche les métadonnées d’un fichier BQRS.

Cette commande affiche une vue d’ensemble des données contenues dans le fichier BQRS binaire compact résultant de l’exécution d’une requête. Elle affiche les noms et les tailles de chaque jeu de résultats (table) dans le fichier BQRS, ainsi que les types de colonnes de chaque jeu de résultats.

Elle peut aussi éventuellement précalculer des décalages pour utiliser les options de pagination de codeql bqrs decode. C’est principalement utile pour les plug-ins des IDE.

Options

Options principales

<file>

[Obligatoire] Fichier BQRS duquel afficher les informations.

--format=<fmt>

Sélectionne le format de sortie text (par défaut) ou json.

Prise en charge de la pagination dans codeql bqrs decode

--paginate-rows=<num>

[Avancé] Lorsque donné avec --format=json, calcule une table de décalages d’octets qui peuvent être donnés ultérieurement à l’option --start-at de codeql bqrs decode, pour démarrer le streaming des résultats aux positions 0, <num> , 2* <num> et ainsi de suite.

--paginate-result-set=<name>

[Avancé] Traite uniquement --paginate-rows pour les jeux de résultats portant ce nom. (Si le nom ne correspond à aucun jeu de résultats, --paginate-rows n’est pas opérationnel).

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.