Extensão:DataDump

From mediawiki.org
This page is a translated version of the page Extension:DataDump and the translation is 64% complete.
Manual de extensões do MediaWiki
DataDump
Estado da versão: estável
Implementação Banco de dados , Página especial
Descrição Fornece uma página especial para gerar/excluir/baixar dumps
Autor(es) Paladox, Universal Omega
Mantenedor(es) Miraheze system administrators
Última versão continuous updates
MediaWiki >= 1.36.0
PHP 7.4+
Modifica o banco
de dados
Sim
Composer miraheze/data-dump
Tabelas data_dump
Licença GNU GPL (Licença Pública Geral) 3.0 ou superior
Download
  • $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.

Para relatar um problema ou um bug, use o Miraheze Phabricator. Veja aqui para a área de trabalho.

Instalação

  • Baixe e coloque o(s) arquivo(s) num diretório chamado DataDump na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php :
    wfLoadExtension( 'DataDump' );
    
  • Execute o script de atualização que criará automaticamente as tabelas de banco de dados necessárias a essa extensão.
  • Configure conforme necessário.
  • Yes Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Configuração

parâmetro padrão comentário
$wgDataDump [] Essa configuração define como os dumps são gerados e quais tipos de dumps existem.
$wgDataDumpDirectory false Esta configuração define o diretório onde armazenar os dumps.
$wgDataDumpDisableGenerate false This config determines whether DataDump should be disabled or not.
$wgDataDumpFileBackend false Esta configuração define o backend para usar ($wgFileBackends)
$wgDataDumpInfo "" Esta configuração define as informações exibidas para Special:Data Dump.
$wgDataDumpLimits ["memory": 0, "filesize": 0, "time": 0, "walltime": 0] Essa configuração define recursos alocados para execução de 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

Exemplo

Este é um exemplo de como configurar a configuração. Você pode adaptá-lo às suas necessidades específicas:

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

Observe que ${filename} é substituído internamente na extensão, e, certifique-se de que esteja sempre em uma única string e não em uma string dupla.

O parâmetro limit especifica quantos dumps podem ser gerados para esse wiki.

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.

Ver também