Extension:DataDump

This page is a translated version of the page Extension:DataDump and the translation is 67% complete.
Manuel des extensions MediaWiki
DataDump
État de la version : stable
Implémentation Base de données , Page spéciale
Description Fournit la page spéciale pour générer/supprimer/télécharger des vidages
Maintenance Miraheze system administrators
Dernière version continuous updates
MediaWiki >= 1.36.0
PHP 7.4+
Modifie la base
de données
Oui
Composer miraheze/data-dump
Tables data_dump
Licence Licence publique générale GNU v3.0 ou supérieur
Téléchargement
  • $wgDataDumpDisableGenerate
  • $wgDataDumpInfo
  • $wgDataDumpDirectory
  • $wgDataDumpFileBackend
  • $wgDataDumpLimits
  • $wgDataDumpDownloadUrl
  • $wgDataDump
  • generate-dump
  • delete-dump
  • view-dump

DataDump allows users to request and generate database dumps. Other types of dumps, such as image dumps, can be configured in the extension. This allows for easy dumping without the need for system administrator intervention.

Pour signaler un problème ou un bogue, veuillez utiliser Miraheze Phabricator. Voir le tableau de travail.

Installation

  • Télécharger et placez le(s) fichier(s) dans un répertoire appelé DataDump dans votre dossier extensions/.
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :
    wfLoadExtension( 'DataDump' );
    
  • Exécutez le script de mise à jour qui va créer automatiquement les tables de base de données dont cette extension a besoin.
  • Configurer si nécessaire.
  •   Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Configuration

paramètre par défaut commentaire
$wgDataDump [] Cette configuration définit comment les vidages sont générés et quels sont leurs types.
$wgDataDumpDirectory false Ce paramètre défiit le répertoire où les dumps seront stockés.
$wgDataDumpDisableGenerate false This config determines whether DataDump should be disabled or not.
$wgDataDumpFileBackend false Ce paramètre définit le serveur à utiliser ($wgFileBackends)
$wgDataDumpInfo "" Ce paramètre définit l'information affichée au début de Special:DataDump.
$wgDataDumpLimits ["memory": 0, "filesize": 0, "time": 0, "walltime": 0] Ce paramètre définit les ressources allouées pour exécuter les scripts.

Permissions

DataDump provides three permissions. These allow you some granularity when it comes to configuring DataDump.

You are not restricted to only using these permissions to restrict who can download, view, or delete dumps. You can also use other permissions available on the wiki.

parameter comment
generate-dump Allows users to generate database dumps
view-dump Allows users to view dumps
delete-dump Allows users to delete dumps

Exemple

Voici un exemple sur la maniètre de définir les paramètres. Vous pouvez l'adapter à vos propres besoins :

$wgDataDumpDirectory = "/var/backups/${wgDBname}/";

$wgDataDump = [
    'xml' => [
        'file_ending' => '.xml.gz',
        'generate' => [
            'type' => 'mwscript',
            'script' => "$IP/maintenance/dumpBackup.php",
            'options' => [
                '--full',
                '--output',
                "gzip:${wgDataDumpDirectory}" . '${filename}',
            ],
        ],
        'limit' => 1,
        'permissions' => [
            'view' => 'view-dump',
            'generate' => 'generate-dump',
            'delete' => 'delete-dump',
        ],
    ],
    'image' => [
        'file_ending' => '.zip',
        'generate' => [
            'type' => 'script',
            'script' => '/usr/bin/zip',
            'options' => [
                '-r',
                "${wgDataDumpDirectory}" . '${filename}',
                "$IP/images/"
            ],
        ],
        'limit' => 1,
        'permissions' => [
            'view' => 'view-dump',
            'generate' => 'generate-dump',
            'delete' => 'delete-dump',
        ],
    ],
];

Notez que ${filename} est remplacé de maniètre interne dans l'extension, donc assurez-vous qu'il s'agit d'une simple chaîne de caractères et non d'une double.

Le paramètre de limite spécifie combien de dumps peuvent être générés pour ce wiki.

Résolution des problèmes

If you're experiencing issues with failed data dumps, you can look at your Job Queue 's log file. You can search for DataDumpGenerateJob to find an area where the Job Queue is running your dump.

PHP binary location

If your log file contains something similar: [exec] Possibly missing executable file: '/usr/bin/php', then you might need to set $wgPhpCli to a correct value for your environment. You can use whereis php to double check.

Zip Tooling

If your log file contains something similar to: [exec] Possibly missing executable file: '/usr/bin/zip' then you need to ensure the appropriate zip tooling for your job is installed on your Host machine.

Voir aussi