Erweiterung:DataDump

From mediawiki.org
This page is a translated version of the page Extension:DataDump and the translation is 64% complete.
MediaWiki-Erweiterungen
DataDump
Freigabestatus: stabil
Einbindung Datenbank , Spezialseite
Beschreibung Bietet eine Spezialseite, um Dumps zu generieren/löschen/herunterladen
Betreuer Miraheze system administrators
Letzte Version continuous updates
MediaWiki >= 1.36.0
PHP 7.4+
Datenbankänderungen Ja
Composer miraheze/data-dump
Tabellen data_dump
Lizenz GNU General Public License 3.0 oder neuer
Herunterladen
  • $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.

Um ein Problem oder einen Fehler zu melden, verwende bitte Miraheze Phabricator. Siehe hier für das Workboard.

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens DataDump im Ordner extensions/ ablegen.
  • Folgenden Code am Ende deiner LocalSettings.php -Datei einfügen:
    wfLoadExtension( 'DataDump' );
    
  • Führe das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
  • Konfiguriere nach Bedarf.
  • Yes Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Konfiguration

Parameter Voreinstellung Anmerkung
$wgDataDump [] Diese Konfiguration definiert, wie Dumps generiert werden und welche Arten von Dumps es gibt.
$wgDataDumpDirectory false Diese Konfiguration definiert das Verzeichnis, in dem die Dumps gespeichert werden.
$wgDataDumpDisableGenerate false This config determines whether DataDump should be disabled or not.
$wgDataDumpFileBackend false Diese Konfiguration definiert das zu verwendende Backend ($wgFileBackends)
$wgDataDumpInfo "" Diese Konfiguration definiert die Informationen, die über Special:DataDump angezeigt werden.
$wgDataDumpLimits ["memory": 0, "filesize": 0, "time": 0, "walltime": 0] Diese Konfiguration definiert Ressourcen, die ausgeführten Skripts zugewiesen werden.

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

Beispiel

Dies ist ein Beispiel dafür, wie du die Konfiguration einrichtest. Du kannst es an deine speziellen Bedürfnisse anpassen:

$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',
        ],
    ],
];

Beachte, dass ${Dateiname} intern in der Erweiterung ersetzt wird. Achte also darauf, dass er immer in einer einfachen und nicht in einer doppelten Zeichenkette steht.

Der Parameter limit gibt an, wie viele Dumps für dieses Wiki generiert werden können.

Troubleshooting

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.

Siehe auch