luyadev/luya-module-exporter

The exporter module allows you to easy download the full databse and storage data from a project to import them local.

LUYA EXPORTER MODULE

This module will not recieve any updates in future and will not release in a stable version as its not recomend to use, use the luya admin proxy instead!, _(*1)

How to use luya proxy instead: https://luya.io/guide/concept-depandsync#sync, _(*2)

The exporter module allowss you to easily download the full database and storage data from a project for a local import and thus, to setup a state of a website at a given time., _(*3)

Installation

Add the exporter module to your composer.json:, _(*4)

"luyadev/luya-module-exporter" : "1.0.0-RC4",

Set up you your application configuration as follows :, _(*5)

'modules' => [
    // ...
    'exporter' => [
        'class' => 'luya\exporter\Module',
        'downloadPassword' => 'EnterYourSecureRandomToken',
    ],
]

And finally run the ./vendor/bin/luya migrate and ./vendor/bin/luya import commands., _(*6)

Using the exporter module

Now you can install a cronjob or run the command when doing deployment to prepare the download:, _(*7)

./vendor/bin/luya exporter/export

In order to download the above created files, just go into:, _(*8)

https://example.com/exporter?p=EnterYourSecureRandomToken and your zip will be downloaded., _(*9)

Attention! HTTP sniffers can read your plain token., _(*10)

Importing from a remote host

To import a database from a remote host, you can use this command:, _(*11)

./vendor/bin/luya exporter/database/remote-replace-local "mysql:host=localhost;dbname=REMOTE_DB_NAME" "USERNAME" "PASSWORD"

Attention! This command will drop all tables in your current database and replace them with the remote export., _(*12)

To use this in a context where you aren't able to process user inputs (chained remote batch processing like in a deployer task) you can disable the security confirmation by adding the parameter --interactive=0. Obviously, this should be used with extreme caution to prevent any unwanted data losses., _(*13)

For your safety there will be an automatically created database backup of the local db. The backup can be found in the local temporary system directory - the file name resembles like this: uniqid() . '-BACKUP-'.time(), _(*14)

Using exporter as a deployer task

When using the LUYA deployer you may want to add the remote replace local command as a task and execute them when deploying the prep environment, here an example of what this could look like, you will find more information in the luya deployer docs:, _(*15)

task('deploy:importProdDb', function() {
    cd('{{release_path}}');
    run('./vendor/bin/luya exporter/database/remote-replace-local "mysql:host=localhost;dbname=prod_database" "USER" "PASSWORD" --interactive=0');
})->onlyOn('prep');

after('deploy:luya', 'deploy:importProdDb');