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 database bundle --output=<output> <options>... -- <database>
codeql database bundle --output=<output> <options>... -- <database>
Description
Crée une archive relocalisable d’une base de données CodeQL.
Commande qui compresse les parties utiles de la base de données. Cela inclut uniquement les composants obligatoires, sauf si l’utilisateur demande spécifiquement que les résultats, journaux, TRAP ou similaires soient inclus.
Options
Options principales
<database>
[Obligatoire] Chemin vers la base de données CodeQL à mettre dans un bundle.
-o, --output=<output>
[Obligatoire] Fichier de sortie, généralement avec l’extension « .zip ».
--[no-]include-diagnostics
Incluez des diagnostics dans le regroupement.
Disponible depuis v2.16.0.
--[no-]include-results
Inclut tous les résultats de requête précalculés dans le bundle.
--[no-]include-logs
Incluez le répertoire des journaux dans le bundle.
Disponible depuis v2.17.6.
--[no-]include-temp
Inclut le répertoire « temp », où se trouvent les packs, requêtes et suites générés.
Disponible depuis v2.13.3.
--[no-]include-uncompressed-source
Inclut une version non compressée du répertoire d’archive source. Nécessaire pour les plug-ins CodeQL hérités (comme CodeQL pour Eclipse).
--name=<name>
Nom du répertoire de niveau supérieur dans le bundle. S’il n’est pas spécifié, utilise par défaut le nom du répertoire de la base de données.
Options de nettoyage de jeu de données de bas niveau
--max-disk-cache=<MB>
Définit la quantité maximale d’espace que le cache de disque peut utiliser pour les résultats de requête intermédiaires.
Si cette taille n’est pas configurée explicitement, l’évaluateur essaie d’utiliser une quantité « raisonnable » d’espace de cache en fonction de la taille du jeu de données et de la complexité des requêtes. La définition explicite d’une limite supérieure à cette utilisation par défaut permet une mise en cache supplémentaire qui peut accélérer les requêtes ultérieures.
--min-disk-free=<MB>
[Avancé] Définit la quantité cible d’espace disponible sur le système de fichiers.
Si --max-disk-cache n’est pas donné, l’évaluateur s’efforce de limiter l’utilisation du cache de disque si l’espace disponible sur le système de fichiers passe en dessous de cette valeur.
--min-disk-free-pct=<pct>
[Avancé] Définit la fraction cible d’espace disponible sur le système de fichiers.
Si --max-disk-cache n’est pas donné, l’évaluateur s’efforce de limiter l’utilisation du cache de disque si l’espace disponible sur le système de fichiers passe en dessous de ce pourcentage.
--cache-cleanup=<mode>
Sélectionnez le degré de réduction du cache. Les options sont les suivantes :
clear: Supprime l’intégralité du cache, en le réduisant à l’état d’un jeu de données qui vient d’être extrait
trim (par défaut) : Supprime tout, sauf les prédicats explicitement « mis en cache ».
fit : S’assure simplement que les limites de taille définies pour le cache de disque sont respectées, en supprimant autant d’intermédiaires que nécessaire.
--cleanup-upgrade-backups
Supprime tous les répertoires de sauvegarde résultant des mises à niveau des bases de données.
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.